API v5.0

This page contains a list of resources available in API v5.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.13.2, so be sure to use clients of the same version.

Initialization

Ruby

require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

JavaScript

import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});

PHP

$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

CLI

$ haveapi-cli -u http://api.vpsfree.cz --version 5.0

File system

# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.0

curl

$ curl --request OPTIONS 'http://api.vpsfree.cz/v5.0/'

HTTP

OPTIONS /v5.0/ HTTP/1.1
Host: api.vpsfree.cz

Authentication methods

Basic


Authentication using HTTP basic. Username and password is passed via HTTP header. Its use is forbidden from web browsers.

Ruby

require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")


client.authenticate(:basic, username: "user", password: "secret")

JavaScript

import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});


api.authenticate("basic", {
  username: "user",
  password: "secret"
}, function (client, status) {
  console.log("Authenticated?", status);
});

PHP

$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");


$api->authenticate("basic", ["username" => "user", "password" => "secret"]);

CLI

# Provide credentials on command line
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 --auth basic --username user --password secret

# If username or password isn't provided, the user is asked on stdin
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 --auth basic --username user
Password: secret

File system

# Provide credentials as file system options
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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=5.0 -o auth_method=basic,user=myuser
Password: secret

curl

# 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'

HTTP

GET / HTTP/1.1
Host: api.vpsfree.cz
Authorization: Basic dXNlcjpzZWNyZXQ=

Token


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.

HTTP header:
X-HaveAPI-Auth-Token
Query parameter:
_auth_token

Resources

Token


Token # Renew

Path:
POST /_auth/token/tokens/renew
Description:
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
hash
Namespace:
token
Label Name Type Description
Valid_to valid_to Datetime

Self-description

{
  "auth": true,
  "description": null,
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "token"
  },
  "output": {
    "parameters": {
      "valid_to": {
        "required": false,
        "label": "Valid_to",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "token"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/_auth/token/tokens/renew",
  "method": "POST",
  "help": "/_auth/token/tokens/renew?method=POST"
}

Token # Request

Path:
POST /_auth/token/tokens
Description:
Authentication required:
no
Aliases:
Blocking:
no

Input parameters

Layout:
hash
Namespace:
token
Label Name Required Type Validators Default Description
User user yes String
Present
empty
false
message
must be present and non-empty
Password password yes String
Present
empty
false
message
must be present and non-empty
Lifetime lifetime yes String
Include
values
["fixed", "renewable_manual", "renewable_auto", "permanent"]
message
%{value} cannot be used
Present
empty
false
message
must be present and non-empty
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.

Output parameters

Layout:
hash
Namespace:
token
Label Name Type Description
Token token String
Valid_to valid_to Datetime
Complete complete Boolean
Next_action next_action String

Self-description

{
  "auth": false,
  "description": null,
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "user": {
        "required": true,
        "label": "User",
        "description": null,
        "type": "String",
        "validators": {
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      },
      "password": {
        "required": true,
        "label": "Password",
        "description": null,
        "type": "String",
        "validators": {
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": true
      },
      "lifetime": {
        "required": true,
        "label": "Lifetime",
        "description": "fixed - the token has a fixed validity period, it cannot be renewed\nrenewable_manual - the token can be renewed, but it must be done manually via renew action\nrenewable_auto - the token is renewed automatically to now+interval every time it is used\npermanent - the token will be valid forever, unless deleted\n",
        "type": "String",
        "validators": {
          "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": [

  ],
  "path": "/_auth/token/tokens",
  "method": "POST",
  "help": "/_auth/token/tokens?method=POST"
}

Token # Revoke

Path:
POST /_auth/token/tokens/revoke
Description:
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": null,
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "token"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "token"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/_auth/token/tokens/revoke",
  "method": "POST",
  "help": "/_auth/token/tokens/revoke?method=POST"
}

Token # Totp

Path:
POST /_auth/token/tokens/totp
Description:
Authentication required:
no
Aliases:
Blocking:
no

Input parameters

Layout:
hash
Namespace:
token
Label Name Required Type Validators Default Description
Token token yes String
Present
empty
false
message
must be present and non-empty
TOTP code code yes String
Present
empty
false
message
must be present and non-empty

Output parameters

Layout:
hash
Namespace:
token
Label Name Type Description
Token token String
Valid_to valid_to Datetime
Complete complete Boolean
Next_action next_action String

Self-description

{
  "auth": false,
  "description": null,
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "token": {
        "required": true,
        "label": "Token",
        "description": null,
        "type": "String",
        "validators": {
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      },
      "code": {
        "required": true,
        "label": "TOTP code",
        "description": null,
        "type": "String",
        "validators": {
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "token"
  },
  "output": {
    "parameters": {
      "token": {
        "required": false,
        "label": "Token",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "valid_to": {
        "required": false,
        "label": "Valid_to",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "complete": {
        "required": false,
        "label": "Complete",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "next_action": {
        "required": false,
        "label": "Next_action",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "token"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/_auth/token/tokens/totp",
  "method": "POST",
  "help": "/_auth/token/tokens/totp?method=POST"
}

Ruby

require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")


# Get token using username and password
client.authenticate(:token, username: "user", password: "secret")

puts "Token = #{client.auth.token}"

# Next time, the client can authenticate using the token directly
client.authenticate(:token, token: saved_token)

JavaScript

import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});


// Request a new token
api.authenticate("token", {
  username: "user",
  password: "secret"
}, function (client, status) {
  console.log("Authenticated?", status);

  if (status)
    console.log("Token is", client.authProvider.token);
});

// Use an existing token
api.authenticate("token", {
  token: "qwertyuiop..."
}, function (client, status) {
  console.log("Authenticated?", status);
});

PHP

$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");


// Get token using username and password
$api->authenticate("token", ["username" => "user", "password" => "secret"]);

echo "Token = ".$api->getAuthenticationProvider()->getToken();

// Next time, the client can authenticate using the token directly
$api->authenticate("token", ["token" => $savedToken]);

CLI

# 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 5.0 --auth token --username user --save user current
Password: secret

# Now the token is read from disk and the user does not have to provide username
# nor password and be authenticated
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 user current

File system

# Authenticate using username and password
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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=5.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.

curl

# Acquire the token
$ curl --request POST \
       --header 'Content-Type: application/json' \
       --data-binary "{
  \"token\": {
    \"user\": \"user\",
    \"password\": \"password\",
    \"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'

HTTP

POST /_auth/token/tokens HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

{
  "token": {
    "user": "user",
    "password": "secret",
    "lifetime": "fixed"
  }
}

Resources

Follows a list of all resources in this API and their actions.

Action state


Browse states of blocking actions

Action state # Cancel

Path:
POST /v5.0/action_states/{action_state_id}/cancel
Description:
Authentication required:
no
Aliases:
Blocking:
yes

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": false,
  "description": null,
  "aliases": [

  ],
  "blocking": true,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "action_state"
  },
  "output": {
    "parameters": {
    },
    "layout": "hash",
    "namespace": "action_state"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/action_states/{action_state_id}/cancel",
  "method": "POST",
  "help": "/v5.0/action_states/{action_state_id}/cancel?method=POST"
}

Action state # Index

Path:
GET /v5.0/action_states
Description:
List states of pending actions
Authentication required:
no
Aliases:
list
Blocking:
no

Input parameters

Layout:
hash
Namespace:
action_state
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
values
["newest", "oldest"]
message
%{value} cannot be used
newest

Output parameters

Layout:
hash_list
Namespace:
action_states
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

Self-description

{
  "auth": false,
  "description": "List states of pending actions",
  "aliases": [
    "list"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "offset": {
        "required": false,
        "label": "Offset",
        "description": "The offset of the first object",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "limit": {
        "required": false,
        "label": "Limit",
        "description": "The number of objects to retrieve",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "order": {
        "required": false,
        "label": "Order",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "newest",
              "oldest"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": "newest",
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "action_state"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "finished": {
        "required": false,
        "label": "Finished",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": "Determines whether the action is proceeding or failing",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "current": {
        "required": false,
        "label": "Current progress",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "total": {
        "required": false,
        "label": "Total",
        "description": "The action is finished when current equals to total",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "unit": {
        "required": false,
        "label": "Unit",
        "description": "Unit of current and total",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "can_cancel": {
        "required": false,
        "label": "Can cancel",
        "description": "When true, execution of this action can be cancelled",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "created_at": {
        "required": false,
        "label": "Created at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "updated_at": {
        "required": false,
        "label": "Updated at",
        "description": "When was the progress last updated",
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash_list",
    "namespace": "action_states"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/action_states",
  "method": "GET",
  "help": "/v5.0/action_states?method=GET"
}

Action state # Poll

Path:
GET /v5.0/action_states/{action_state_id}/poll
Description:
Returns when the action is completed or timeout occurs
Authentication required:
no
Aliases:
Blocking:
no

Input parameters

Layout:
hash
Namespace:
action_state
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

Output parameters

Layout:
hash
Namespace:
action_state
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

Self-description

{
  "auth": false,
  "description": "Returns when the action is completed or timeout occurs",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "timeout": {
        "required": false,
        "label": "Timeout",
        "description": "in seconds",
        "type": "Float",
        "validators": {
        },
        "default": 15,
        "protected": false
      },
      "update_in": {
        "required": false,
        "label": "Progress",
        "description": "number of seconds after which the state is returned if the progress has changed",
        "type": "Float",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": "status to check with if update_in is set",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "current": {
        "required": false,
        "label": "Current",
        "description": "progress to check with if update_in is set",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "total": {
        "required": false,
        "label": "Total",
        "description": "progress to check with if update_in is set",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "action_state"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "finished": {
        "required": false,
        "label": "Finished",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": "Determines whether the action is proceeding or failing",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "current": {
        "required": false,
        "label": "Current progress",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "total": {
        "required": false,
        "label": "Total",
        "description": "The action is finished when current equals to total",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "unit": {
        "required": false,
        "label": "Unit",
        "description": "Unit of current and total",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "can_cancel": {
        "required": false,
        "label": "Can cancel",
        "description": "When true, execution of this action can be cancelled",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "created_at": {
        "required": false,
        "label": "Created at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "updated_at": {
        "required": false,
        "label": "Updated at",
        "description": "When was the progress last updated",
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "action_state"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/action_states/{action_state_id}/poll",
  "method": "GET",
  "help": "/v5.0/action_states/{action_state_id}/poll?method=GET"
}

Action state # Show

Path:
GET /v5.0/action_states/{action_state_id}
Description:
Show state of a pending action
Authentication required:
no
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
hash
Namespace:
action_state
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

Self-description

{
  "auth": false,
  "description": "Show state of a pending action",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "action_state"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "finished": {
        "required": false,
        "label": "Finished",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": "Determines whether the action is proceeding or failing",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "current": {
        "required": false,
        "label": "Current progress",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "total": {
        "required": false,
        "label": "Total",
        "description": "The action is finished when current equals to total",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "unit": {
        "required": false,
        "label": "Unit",
        "description": "Unit of current and total",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "can_cancel": {
        "required": false,
        "label": "Can cancel",
        "description": "When true, execution of this action can be cancelled",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "created_at": {
        "required": false,
        "label": "Created at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "updated_at": {
        "required": false,
        "label": "Updated at",
        "description": "When was the progress last updated",
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "action_state"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/action_states/{action_state_id}",
  "method": "GET",
  "help": "/v5.0/action_states/{action_state_id}?method=GET"
}

Cluster


Manage cluster

Cluster # Full_stats

Path:
GET /v5.0/cluster/full_stats
Description:
Full statistics information
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
hash
Namespace:
cluster
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

Self-description

{
  "auth": true,
  "description": "Full statistics information",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "cluster"
  },
  "output": {
    "parameters": {
      "nodes_online": {
        "required": false,
        "label": "Nodes_online",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "node_count": {
        "required": false,
        "label": "Node_count",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_running": {
        "required": false,
        "label": "Vps_running",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_stopped": {
        "required": false,
        "label": "Vps_stopped",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_suspended": {
        "required": false,
        "label": "Vps_suspended",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_deleted": {
        "required": false,
        "label": "Vps_deleted",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_count": {
        "required": false,
        "label": "Vps_count",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_active": {
        "required": false,
        "label": "User_active",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_suspended": {
        "required": false,
        "label": "User_suspended",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_deleted": {
        "required": false,
        "label": "User_deleted",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_count": {
        "required": false,
        "label": "User_count",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ipv4_used": {
        "required": false,
        "label": "Ipv4_used",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ipv4_count": {
        "required": false,
        "label": "Ipv4_count",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "cluster"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster/full_stats",
  "method": "GET",
  "help": "/v5.0/cluster/full_stats?method=GET"
}

Cluster # Public_stats

Path:
GET /v5.0/cluster/public_stats
Description:
Public statistics information
Authentication required:
no
Aliases:
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
cluster
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

Self-description

{
  "auth": false,
  "description": "Public statistics information",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "cluster"
  },
  "output": {
    "parameters": {
      "user_count": {
        "required": false,
        "label": "Number of users",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_count": {
        "required": false,
        "label": "Number of VPSes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ipv4_left": {
        "required": false,
        "label": "Number of free public IPv4 addresses",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [
    {
      "title": "",
      "comment": null,
      "path_params": null,
      "request": {
      },
      "response": {
        "user_count": 1100,
        "vps_count": 1560,
        "ipv4_left": 256
      },
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/cluster/public_stats",
  "method": "GET",
  "help": "/v5.0/cluster/public_stats?method=GET"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.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
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.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
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.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
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 cluster public_stats
                      Number of users:  1100
                      Number of VPSes:  1560
 Number of free public IPv4 addresses:  256

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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
$ curl --request GET \
       --data-binary "{
  \"cluster\": {
  }
}" \
       'http://api.vpsfree.cz/v5.0/cluster/public_stats'
Response
{
  "status": true,
  "message": null,
  "response": {
    "cluster": {
      "user_count": 1100,
      "vps_count": 1560,
      "ipv4_left": 256
    }
  },
  "errors": null
}
HTTP
Request
GET /v5.0/cluster/public_stats HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

Response
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
}
Path:
POST /v5.0/cluster/search
Description:
Search users and VPSes by IDs, names and owned objects
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
hash
Namespace:
cluster
Label Name Required Type Validators Default Description
Value value yes String
Present
empty
false
message
must be present and non-empty
Value to be searched for

Output parameters

Layout:
hash_list
Namespace:
clusters
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

Self-description

{
  "auth": true,
  "description": "Search users and VPSes by IDs, names and owned objects",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "value": {
        "required": true,
        "label": "Value",
        "description": "Value to be searched for",
        "type": "String",
        "validators": {
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "cluster"
  },
  "output": {
    "parameters": {
      "resource": {
        "required": false,
        "label": "Resource",
        "description": "Resource name of the located object",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "id": {
        "required": false,
        "label": "ID",
        "description": "Identifier of the located object",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "attribute": {
        "required": false,
        "label": "Attribute",
        "description": "Name of the attribute containing the searched value",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "value": {
        "required": false,
        "label": "Value",
        "description": "Located value",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "hash_list",
    "namespace": "clusters"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster/search",
  "method": "POST",
  "help": "/v5.0/cluster/search?method=POST"
}

Cluster # Set_maintenance

Path:
POST /v5.0/cluster/set_maintenance
Description:
Set maintenance lock
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
hash
Namespace:
cluster
Label Name Required Type Validators Default Description
Lock lock yes Boolean
Present
empty
false
message
must be present and non-empty
Reason reason no String

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Set maintenance lock",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "lock": {
        "required": true,
        "label": "Lock",
        "description": null,
        "type": "Boolean",
        "validators": {
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      },
      "reason": {
        "required": false,
        "label": "Reason",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": "",
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "cluster"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "cluster"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster/set_maintenance",
  "method": "POST",
  "help": "/v5.0/cluster/set_maintenance?method=POST"
}

Cluster # Show

Path:
GET /v5.0/cluster
Description:
Cluster information
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
cluster
Label Name Type Description
Maintenance_lock maintenance_lock Boolean
Maintenance_lock_reason maintenance_lock_reason String

Self-description

{
  "auth": true,
  "description": "Cluster information",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "cluster"
  },
  "output": {
    "parameters": {
      "maintenance_lock": {
        "required": false,
        "label": "Maintenance_lock",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "maintenance_lock_reason": {
        "required": false,
        "label": "Maintenance_lock_reason",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster"
  },
  "meta": {
    "object": null,
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster",
  "method": "GET",
  "help": "/v5.0/cluster?method=GET"
}

Cluster resource


Manage environment resources

Cluster resource # Create

Path:
POST /v5.0/cluster_resources
Description:
Create an environment resource
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
cluster_resource
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

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Create an environment resource",
  "aliases": [
    "new"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "name": {
        "required": false,
        "label": "Resource name for internal purposes",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "min": {
        "required": false,
        "label": "Minimum value",
        "description": "When an object is allocating a resource, it must use more than minimum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max": {
        "required": false,
        "label": "Maximum value",
        "description": "When an object is allocating a resource, it must not use more than maximum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "stepsize": {
        "required": false,
        "label": "Step size",
        "description": "Steps in which the objects allocated resource value may be iterated",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster_resource"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "cluster_resource"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resources",
  "method": "POST",
  "help": "/v5.0/cluster_resources?method=POST"
}

Cluster resource # Index

Path:
GET /v5.0/cluster_resources
Description:
List environment resources
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
cluster_resource
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

Output parameters

Layout:
object_list
Namespace:
cluster_resources
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

Self-description

{
  "auth": true,
  "description": "List environment resources",
  "aliases": [
    "list"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "offset": {
        "required": false,
        "label": "Offset",
        "description": "The offset of the first object",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "limit": {
        "required": false,
        "label": "Limit",
        "description": "The number of objects to retrieve",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster_resource"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "name": {
        "required": false,
        "label": "Resource name for internal purposes",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "min": {
        "required": false,
        "label": "Minimum value",
        "description": "When an object is allocating a resource, it must use more than minimum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max": {
        "required": false,
        "label": "Maximum value",
        "description": "When an object is allocating a resource, it must not use more than maximum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "stepsize": {
        "required": false,
        "label": "Step size",
        "description": "Steps in which the objects allocated resource value may be iterated",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "cluster_resources"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resources",
  "method": "GET",
  "help": "/v5.0/cluster_resources?method=GET"
}

Cluster resource # Show

Path:
GET /v5.0/cluster_resources/{cluster_resource_id}
Description:
Show environment resource
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
cluster_resource
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

Self-description

{
  "auth": true,
  "description": "Show environment resource",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "cluster_resource"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "name": {
        "required": false,
        "label": "Resource name for internal purposes",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "min": {
        "required": false,
        "label": "Minimum value",
        "description": "When an object is allocating a resource, it must use more than minimum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max": {
        "required": false,
        "label": "Maximum value",
        "description": "When an object is allocating a resource, it must not use more than maximum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "stepsize": {
        "required": false,
        "label": "Step size",
        "description": "Steps in which the objects allocated resource value may be iterated",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster_resource"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resources/{cluster_resource_id}",
  "method": "GET",
  "help": "/v5.0/cluster_resources/{cluster_resource_id}?method=GET"
}

Cluster resource # Update

Path:
PUT /v5.0/cluster_resources/{cluster_resource_id}
Description:
Update an environment resource
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
cluster_resource
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

Output parameters

Layout:
object
Namespace:
cluster_resource
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

Self-description

{
  "auth": true,
  "description": "Update an environment resource",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "name": {
        "required": false,
        "label": "Resource name for internal purposes",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "min": {
        "required": false,
        "label": "Minimum value",
        "description": "When an object is allocating a resource, it must use more than minimum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max": {
        "required": false,
        "label": "Maximum value",
        "description": "When an object is allocating a resource, it must not use more than maximum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "stepsize": {
        "required": false,
        "label": "Step size",
        "description": "Steps in which the objects allocated resource value may be iterated",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster_resource"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "name": {
        "required": false,
        "label": "Resource name for internal purposes",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "min": {
        "required": false,
        "label": "Minimum value",
        "description": "When an object is allocating a resource, it must use more than minimum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max": {
        "required": false,
        "label": "Maximum value",
        "description": "When an object is allocating a resource, it must not use more than maximum",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "stepsize": {
        "required": false,
        "label": "Step size",
        "description": "Steps in which the objects allocated resource value may be iterated",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster_resource"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resources/{cluster_resource_id}",
  "method": "PUT",
  "help": "/v5.0/cluster_resources/{cluster_resource_id}?method=PUT"
}

Cluster resource package


Manage cluster resource packages

Cluster resource package # Create

Path:
POST /v5.0/cluster_resource_packages
Description:
Create a cluster resource package
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
cluster_resource_package
Label Name Required Type Validators Default Description
Label label yes String
Present
empty
false
message
must be present and non-empty
Length
message
length has to be minimally 2
min
2

Output parameters

Layout:
object
Namespace:
cluster_resource_package
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

Self-description

{
  "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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "updated_at": {
        "required": false,
        "label": "Updated_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster_resource_package"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages",
  "method": "POST",
  "help": "/v5.0/cluster_resource_packages?method=POST"
}

Cluster resource package # Delete

Path:
DELETE /v5.0/cluster_resource_packages/{cluster_resource_package_id}
Description:
Delete a cluster resource package
Authentication required:
yes
Aliases:
destroy
Blocking:
no

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Delete a cluster resource package",
  "aliases": [
    "destroy"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "cluster_resource_package"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "cluster_resource_package"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}",
  "method": "DELETE",
  "help": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}?method=DELETE"
}

Cluster resource package # Index

Path:
GET /v5.0/cluster_resource_packages
Description:
List cluster resource packages
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
cluster_resource_package
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

Output parameters

Layout:
object_list
Namespace:
cluster_resource_packages
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

Self-description

{
  "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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "updated_at": {
        "required": false,
        "label": "Updated_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "cluster_resource_packages"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages",
  "method": "GET",
  "help": "/v5.0/cluster_resource_packages?method=GET"
}

Cluster resource package # Show

Path:
GET /v5.0/cluster_resource_packages/{cluster_resource_package_id}
Description:
Show cluster resource package
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
cluster_resource_package
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

Self-description

{
  "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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "updated_at": {
        "required": false,
        "label": "Updated_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster_resource_package"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}",
  "method": "GET",
  "help": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}?method=GET"
}

Cluster resource package # Update

Path:
PUT /v5.0/cluster_resource_packages/{cluster_resource_package_id}
Description:
Update a cluster resource package
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
cluster_resource_package
Label Name Required Type Validators Default Description
Label label yes String
Present
empty
false
message
must be present and non-empty
Length
message
length has to be minimally 2
min
2

Output parameters

Layout:
object
Namespace:
cluster_resource_package
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

Self-description

{
  "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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "updated_at": {
        "required": false,
        "label": "Updated_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "cluster_resource_package"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}",
  "method": "PUT",
  "help": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}?method=PUT"
}

Item


Manage cluster resource package contents

Cluster resource package.Item # Create

Path:
POST /v5.0/cluster_resource_packages/{cluster_resource_package_id}/items
Description:
Add item to a cluster resource package
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
item
Label Name Required Type Validators Default Description
ClusterResource cluster_resource no Resource
Value value no Integer

Output parameters

Layout:
object
Namespace:
item
Label Name Type Description
Id id Integer
ClusterResource cluster_resource Resource
Value value Integer

Self-description

{
  "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": "/v5.0/cluster_resources",
          "method": "GET",
          "help": "/v5.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": "/v5.0/cluster_resources",
          "method": "GET",
          "help": "/v5.0/cluster_resources?method=GET"
        }
      },
      "value": {
        "required": false,
        "label": "Value",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "item"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items",
  "method": "POST",
  "help": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items?method=POST"
}

Cluster resource package.Item # Delete

Path:
DELETE /v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}
Description:
Delete an item from a cluster resource package
Authentication required:
yes
Aliases:
destroy
Blocking:
no

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Delete an item from a cluster resource package",
  "aliases": [
    "destroy"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "item"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "item"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}",
  "method": "DELETE",
  "help": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}?method=DELETE"
}

Cluster resource package.Item # Index

Path:
GET /v5.0/cluster_resource_packages/{cluster_resource_package_id}/items
Description:
List cluster resource package contents
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
item
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

Output parameters

Layout:
object_list
Namespace:
items
Label Name Type Description
Id id Integer
ClusterResource cluster_resource Resource
Value value Integer

Self-description

{
  "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": "/v5.0/cluster_resources",
          "method": "GET",
          "help": "/v5.0/cluster_resources?method=GET"
        }
      },
      "value": {
        "required": false,
        "label": "Value",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "items"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items",
  "method": "GET",
  "help": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items?method=GET"
}

Cluster resource package.Item # Show

Path:
GET /v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}
Description:
Show cluster resource package item
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
item
Label Name Type Description
Id id Integer
ClusterResource cluster_resource Resource
Value value Integer

Self-description

{
  "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": "/v5.0/cluster_resources",
          "method": "GET",
          "help": "/v5.0/cluster_resources?method=GET"
        }
      },
      "value": {
        "required": false,
        "label": "Value",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "item"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}",
  "method": "GET",
  "help": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}?method=GET"
}

Cluster resource package.Item # Update

Path:
PUT /v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}
Description:
Update item in a cluster resource package
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
item
Label Name Required Type Validators Default Description
Value value no Integer

Output parameters

Layout:
object
Namespace:
item
Label Name Type Description
Id id Integer
ClusterResource cluster_resource Resource
Value value Integer

Self-description

{
  "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": "/v5.0/cluster_resources",
          "method": "GET",
          "help": "/v5.0/cluster_resources?method=GET"
        }
      },
      "value": {
        "required": false,
        "label": "Value",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "item"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}",
  "method": "PUT",
  "help": "/v5.0/cluster_resource_packages/{cluster_resource_package_id}/items/{item_id}?method=PUT"
}

Dataset


Manage datasets

Dataset # Create

Path:
POST /v5.0/datasets
Description:
Create a subdataset
Authentication required:
yes
Aliases:
new
Blocking:
yes

Input parameters

Layout:
object
Namespace:
dataset
Label Name Required Type Validators Default Description
Name name yes String
Format
rx
\A[a-zA-Z0-9][a-zA-Z0-9_\-:\./]{0,254}\z
match
true
description
message
'%{value}' is not a valid dataset name
Present
empty
false
message
must be present and non-empty
Parent dataset dataset no Resource
Inherit_user_namespace_map inherit_user_namespace_map no Boolean true
UID/GID mapping user_namespace_map 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
values
["standard", "disabled"]
message
%{value} cannot be used
standard Controls the behavior of synchronous requests
NFS share sharenfs no String Controls NFS sharing

Output parameters

Layout:
object
Namespace:
dataset
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
UID/GID mapping user_namespace_map Resource
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

Self-description

{
  "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": "/v5.0/datasets",
          "method": "GET",
          "help": "/v5.0/datasets?method=GET"
        }
      },
      "inherit_user_namespace_map": {
        "required": false,
        "label": "Inherit_user_namespace_map",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": true,
        "protected": false
      },
      "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": "/v5.0/user_namespace_maps",
          "method": "GET",
          "help": "/v5.0/user_namespace_maps?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": "/v5.0/datasets",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/user_namespace_maps",
          "method": "GET",
          "help": "/v5.0/user_namespace_maps?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
      }
    },
    "layout": "object",
    "namespace": "dataset"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets",
  "method": "POST",
  "help": "/v5.0/datasets?method=POST"
}

Dataset # Delete

Path:
DELETE /v5.0/datasets/{dataset_id}
Description:
Destroy a dataset with all its subdatasets and snapshots
Authentication required:
yes
Aliases:
destroy
Blocking:
yes

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Destroy a dataset with all its subdatasets and snapshots",
  "aliases": [
    "destroy"
  ],
  "blocking": true,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "dataset"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "dataset"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}",
  "method": "DELETE",
  "help": "/v5.0/datasets/{dataset_id}?method=DELETE"
}

Dataset # Index

Path:
GET /v5.0/datasets
Description:
List datasets
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
dataset
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
UID/GID mapping user_namespace_map no Resource
Role role no String
Include
values
["hypervisor", "primary", "backup"]
message
%{value} cannot be used
Show only datasets of certain role
To depth to_depth no Integer Show only datasets to certain depth

Output parameters

Layout:
object_list
Namespace:
datasets
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
UID/GID mapping user_namespace_map Resource
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

Self-description

{
  "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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/datasets",
          "method": "GET",
          "help": "/v5.0/datasets?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": "/v5.0/user_namespace_maps",
          "method": "GET",
          "help": "/v5.0/user_namespace_maps?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": "/v5.0/datasets",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/user_namespace_maps",
          "method": "GET",
          "help": "/v5.0/user_namespace_maps?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
      }
    },
    "layout": "object_list",
    "namespace": "datasets"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets",
  "method": "GET",
  "help": "/v5.0/datasets?method=GET"
}

Dataset # Inherit

Path:
POST /v5.0/datasets/{dataset_id}/inherit
Description:
Inherit dataset property
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

Layout:
object
Namespace:
dataset
Label Name Required Type Validators Default Description
Property property yes String
Present
empty
false
message
must be present and non-empty
Name of property to inherit from parent, multiple properties may be separated by a comma

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Inherit dataset property",
  "aliases": [

  ],
  "blocking": true,
  "input": {
    "parameters": {
      "property": {
        "required": true,
        "label": "Property",
        "description": "Name of property to inherit from parent, multiple properties may be separated by a comma",
        "type": "String",
        "validators": {
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "dataset"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "dataset"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/inherit",
  "method": "POST",
  "help": "/v5.0/datasets/{dataset_id}/inherit?method=POST"
}

Dataset # Show

Path:
GET /v5.0/datasets/{dataset_id}
Description:
Show a dataset
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
dataset
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
UID/GID mapping user_namespace_map Resource
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

Self-description

{
  "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": "/v5.0/datasets",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/user_namespace_maps",
          "method": "GET",
          "help": "/v5.0/user_namespace_maps?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
      }
    },
    "layout": "object",
    "namespace": "dataset"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}",
  "method": "GET",
  "help": "/v5.0/datasets/{dataset_id}?method=GET"
}

Dataset # Update

Path:
PUT /v5.0/datasets/{dataset_id}
Description:
Update a dataset
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

Layout:
object
Namespace:
dataset
Label Name Required Type Validators Default Description
UID/GID mapping user_namespace_map no Resource
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
values
["standard", "disabled"]
message
%{value} cannot be used
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
values
["no_lock", "absolute", "not_less", "not_more"]
message
%{value} cannot be used
How is the admin lock enforced

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Update a dataset",
  "aliases": [

  ],
  "blocking": true,
  "input": {
    "parameters": {
      "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": "/v5.0/user_namespace_maps",
          "method": "GET",
          "help": "/v5.0/user_namespace_maps?method=GET"
        }
      },
      "atime": {
        "required": false,
        "label": "Access time",
        "description": "Controls whether the access time for files is updated when they are read",
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "compression": {
        "required": false,
        "label": "Compression",
        "description": "Toggle data compression in this dataset",
        "type": "Boolean",
        "validators": {
        },
        "default": true,
        "protected": false
      },
      "recordsize": {
        "required": false,
        "label": "Record size",
        "description": "Specifies a suggested block size for files in the file system",
        "type": "Integer",
        "validators": {
        },
        "default": 131072,
        "protected": false
      },
      "quota": {
        "required": false,
        "label": "Quota",
        "description": "Limits the amount of space a dataset and all its descendants can consume",
        "type": "Integer",
        "validators": {
        },
        "default": 0,
        "protected": false
      },
      "refquota": {
        "required": false,
        "label": "Reference quota",
        "description": "Limits the amount of space a dataset can consume",
        "type": "Integer",
        "validators": {
        },
        "default": 0,
        "protected": false
      },
      "relatime": {
        "required": false,
        "label": "Relative access time",
        "description": "Access time is only updated if the previous access time was earlier than the current modify or change time or if the existing access time hasn't been updated within the past 24 hours",
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "sync": {
        "required": false,
        "label": "Sync",
        "description": "Controls the behavior of synchronous requests",
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "standard",
              "disabled"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": "standard",
        "protected": false
      },
      "sharenfs": {
        "required": false,
        "label": "NFS share",
        "description": "Controls NFS sharing",
        "type": "String",
        "validators": {
        },
        "default": "",
        "protected": false
      },
      "admin_override": {
        "required": false,
        "label": "Admin override",
        "description": "Make it possible to assign more resource than the user actually has",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "admin_lock_type": {
        "required": false,
        "label": "Admin lock type",
        "description": "How is the admin lock enforced",
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "no_lock",
              "absolute",
              "not_less",
              "not_more"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "dataset"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "dataset"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}",
  "method": "PUT",
  "help": "/v5.0/datasets/{dataset_id}?method=PUT"
}

Plan


Manage dataset plans

Dataset.Plan # Create

Path:
POST /v5.0/datasets/{dataset_id}/plans
Description:
Assign new dataset plan
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
plan
Label Name Required Type Validators Default Description
Environment_dataset_plan environment_dataset_plan yes Resource

Output parameters

Layout:
object
Namespace:
plan
Label Name Type Description
Id id Integer
Environment_dataset_plan environment_dataset_plan Resource

Self-description

{
  "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": "/v5.0/environments/{environment_id}/dataset_plans",
          "method": "GET",
          "help": "/v5.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": "/v5.0/environments/{environment_id}/dataset_plans",
          "method": "GET",
          "help": "/v5.0/environments/{environment_id}/dataset_plans?method=GET"
        }
      }
    },
    "layout": "object",
    "namespace": "plan"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/plans",
  "method": "POST",
  "help": "/v5.0/datasets/{dataset_id}/plans?method=POST"
}

Dataset.Plan # Delete

Path:
DELETE /v5.0/datasets/{dataset_id}/plans/{plan_id}
Description:
Remove dataset plan
Authentication required:
yes
Aliases:
destroy
Blocking:
no

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Remove dataset plan",
  "aliases": [
    "destroy"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "plan"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "plan"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/plans/{plan_id}",
  "method": "DELETE",
  "help": "/v5.0/datasets/{dataset_id}/plans/{plan_id}?method=DELETE"
}

Dataset.Plan # Index

Path:
GET /v5.0/datasets/{dataset_id}/plans
Description:
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
plan
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

Output parameters

Layout:
object_list
Namespace:
plans
Label Name Type Description
Id id Integer
Environment_dataset_plan environment_dataset_plan Resource

Self-description

{
  "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": "/v5.0/environments/{environment_id}/dataset_plans",
          "method": "GET",
          "help": "/v5.0/environments/{environment_id}/dataset_plans?method=GET"
        }
      }
    },
    "layout": "object_list",
    "namespace": "plans"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/plans",
  "method": "GET",
  "help": "/v5.0/datasets/{dataset_id}/plans?method=GET"
}

Dataset.Plan # Show

Path:
GET /v5.0/datasets/{dataset_id}/plans/{plan_id}
Description:
Show dataset plan
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
plan
Label Name Type Description
Id id Integer
Environment_dataset_plan environment_dataset_plan Resource

Self-description

{
  "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": "/v5.0/environments/{environment_id}/dataset_plans",
          "method": "GET",
          "help": "/v5.0/environments/{environment_id}/dataset_plans?method=GET"
        }
      }
    },
    "layout": "object",
    "namespace": "plan"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/plans/{plan_id}",
  "method": "GET",
  "help": "/v5.0/datasets/{dataset_id}/plans/{plan_id}?method=GET"
}

Property history


View property history

Dataset.Property history # Index

Path:
GET /v5.0/datasets/{dataset_id}/property_history
Description:
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
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

Output parameters

Layout:
object_list
Namespace:
property_histories
Label Name Type Description
Id id Integer
Name name String
Value value Integer
Created_at created_at Datetime

Self-description

{
  "auth": true,
  "description": null,
  "aliases": [
    "list"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "offset": {
        "required": false,
        "label": "Offset",
        "description": "The offset of the first object",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "limit": {
        "required": false,
        "label": "Limit",
        "description": "The number of objects to retrieve",
        "type": "Integer",
        "validators": {
        },
        "default": 25,
        "protected": false
      },
      "from": {
        "required": false,
        "label": "From",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "to": {
        "required": false,
        "label": "To",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "name": {
        "required": false,
        "label": "Name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "property_history"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "name": {
        "required": false,
        "label": "Name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "value": {
        "required": false,
        "label": "Value",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "property_histories"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/property_history",
  "method": "GET",
  "help": "/v5.0/datasets/{dataset_id}/property_history?method=GET"
}

Dataset.Property history # Show

Path:
GET /v5.0/datasets/{dataset_id}/property_history/{property_history_id}
Description:
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
property_history
Label Name Type Description
Id id Integer
Name name String
Value value Integer
Created_at created_at Datetime

Self-description

{
  "auth": true,
  "description": null,
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "property_history"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "name": {
        "required": false,
        "label": "Name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "value": {
        "required": false,
        "label": "Value",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "property_history"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/property_history/{property_history_id}",
  "method": "GET",
  "help": "/v5.0/datasets/{dataset_id}/property_history/{property_history_id}?method=GET"
}

Snapshot


Manage dataset snapshots

Dataset.Snapshot # Create

Path:
POST /v5.0/datasets/{dataset_id}/snapshots
Description:
Create snapshot
Authentication required:
yes
Aliases:
new
Blocking:
yes

Input parameters

Layout:
object
Namespace:
snapshot
Label Name Required Type Validators Default Description
Label label no String

Output parameters

Layout:
object
Namespace:
snapshot
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

Self-description

{
  "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": "/v5.0/datasets",
          "method": "GET",
          "help": "/v5.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": "/v5.0/vpses/{vps_id}/mounts",
          "method": "GET",
          "help": "/v5.0/vpses/{vps_id}/mounts?method=GET"
        }
      }
    },
    "layout": "object",
    "namespace": "snapshot"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/snapshots",
  "method": "POST",
  "help": "/v5.0/datasets/{dataset_id}/snapshots?method=POST"
}

Dataset.Snapshot # Delete

Path:
DELETE /v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}
Description:
Destroy a snapshot
Authentication required:
yes
Aliases:
destroy
Blocking:
yes

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Destroy a snapshot",
  "aliases": [
    "destroy"
  ],
  "blocking": true,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "snapshot"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "snapshot"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}",
  "method": "DELETE",
  "help": "/v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}?method=DELETE"
}

Dataset.Snapshot # Index

Path:
GET /v5.0/datasets/{dataset_id}/snapshots
Description:
List snapshots
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
snapshot
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

Output parameters

Layout:
object_list
Namespace:
snapshots
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

Self-description

{
  "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": "/v5.0/datasets",
          "method": "GET",
          "help": "/v5.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": "/v5.0/vpses/{vps_id}/mounts",
          "method": "GET",
          "help": "/v5.0/vpses/{vps_id}/mounts?method=GET"
        }
      }
    },
    "layout": "object_list",
    "namespace": "snapshots"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/snapshots",
  "method": "GET",
  "help": "/v5.0/datasets/{dataset_id}/snapshots?method=GET"
}

Dataset.Snapshot # Rollback

Path:
POST /v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}/rollback
Description:
Rollback to a snapshot
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Rollback to a snapshot",
  "aliases": [

  ],
  "blocking": true,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "snapshot"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "snapshot"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}/rollback",
  "method": "POST",
  "help": "/v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}/rollback?method=POST"
}

Dataset.Snapshot # Show

Path:
GET /v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}
Description:
Show snapshot
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
snapshot
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

Self-description

{
  "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": "/v5.0/datasets",
          "method": "GET",
          "help": "/v5.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": "/v5.0/vpses/{vps_id}/mounts",
          "method": "GET",
          "help": "/v5.0/vpses/{vps_id}/mounts?method=GET"
        }
      }
    },
    "layout": "object",
    "namespace": "snapshot"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}",
  "method": "GET",
  "help": "/v5.0/datasets/{dataset_id}/snapshots/{snapshot_id}?method=GET"
}

Dataset plan


See dataset plans

Dataset plan # Index

Path:
GET /v5.0/dataset_plans
Description:
List dataset plans
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
dataset_plan
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

Output parameters

Layout:
object_list
Namespace:
dataset_plans
Label Name Type Description
ID id Integer
Label label String
Description description String

Self-description

{
  "auth": true,
  "description": "List dataset plans",
  "aliases": [
    "list"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "offset": {
        "required": false,
        "label": "Offset",
        "description": "The offset of the first object",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "limit": {
        "required": false,
        "label": "Limit",
        "description": "The number of objects to retrieve",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "dataset_plan"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "ID",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "description": {
        "required": false,
        "label": "Description",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "dataset_plans"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/dataset_plans",
  "method": "GET",
  "help": "/v5.0/dataset_plans?method=GET"
}

Dataset plan # Show

Path:
GET /v5.0/dataset_plans/{dataset_plan_id}
Description:
Show dataset plan
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
dataset_plan
Label Name Type Description
ID id Integer
Label label String
Description description String

Self-description

{
  "auth": true,
  "description": "Show dataset plan",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "dataset_plan"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "ID",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "description": {
        "required": false,
        "label": "Description",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "dataset_plan"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/dataset_plans/{dataset_plan_id}",
  "method": "GET",
  "help": "/v5.0/dataset_plans/{dataset_plan_id}?method=GET"
}

Dns resolver


Manage DNS resolvers

Dns resolver # Create

Path:
POST /v5.0/dns_resolvers
Description:
Create a DNS resolver
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
dns_resolver
Label Name Required Type Validators Default Description
IP address ip_addr yes String
Present
empty
false
message
must be present and non-empty
Multiple addresses separated by comma
Label label yes String
Present
empty
false
message
must be present and non-empty
Is universal? is_universal yes Boolean
Present
empty
false
message
must be present and non-empty
Universal resolver is independent on location
Location location no Resource Location this resolver can be used on

Output parameters

Layout:
object
Namespace:
dns_resolver
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

Self-description

{
  "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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.0/locations?method=GET"
        }
      }
    },
    "layout": "object",
    "namespace": "dns_resolver"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/dns_resolvers",
  "method": "POST",
  "help": "/v5.0/dns_resolvers?method=POST"
}

Dns resolver # Delete

Path:
DELETE /v5.0/dns_resolvers/{dns_resolver_id}
Description:
Authentication required:
yes
Aliases:
destroy
Blocking:
no

Input parameters

Layout:
object
Namespace:
dns_resolver
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.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": null,
  "aliases": [
    "destroy"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "force": {
        "required": false,
        "label": "Force deletion",
        "description": "Delete the DNS resolver even it is in use. Affected VPSes get a new DNS resolver.",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "dns_resolver"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "dns_resolver"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/dns_resolvers/{dns_resolver_id}",
  "method": "DELETE",
  "help": "/v5.0/dns_resolvers/{dns_resolver_id}?method=DELETE"
}

Dns resolver # Index

Path:
GET /v5.0/dns_resolvers
Description:
List DNS resolvers
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
dns_resolver
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

Output parameters

Layout:
object_list
Namespace:
dns_resolvers
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

Self-description

{
  "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": "/v5.0/vpses",
          "method": "GET",
          "help": "/v5.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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.0/locations?method=GET"
        }
      }
    },
    "layout": "object_list",
    "namespace": "dns_resolvers"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [
    {
      "title": "",
      "comment": null,
      "path_params": null,
      "request": {
      },
      "response": [
        {
          "id": 26,
          "ip_addr": "8.8.8.8",
          "label": "Google DNS",
          "is_universal": true,
          "location": null
        }
      ],
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/dns_resolvers",
  "method": "GET",
  "help": "/v5.0/dns_resolvers?method=GET"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.dns_resolver.index

# reply is an instance of HaveAPI::Client::ResourceInstanceList,
# which is a subclass of Array
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});

api.dns_resolver.index(function (client, reply) {
  console.log('Response', reply);
  // reply is an instance of HaveAPI.Client.ResourceInstanceList
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->dns_resolver->index();

// $reply is an instance of \HaveAPI\Client\ResourceInstanceList
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 dns_resolver index
            ID:  26
    IP address:  8.8.8.8
         Label:  Google DNS
 Is universal?:  true
      Location:  -

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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
$ curl --request GET \
       --data-binary "{
  \"dns_resolver\": {
  }
}" \
       'http://api.vpsfree.cz/v5.0/dns_resolvers'
Response
{
  "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
}
HTTP
Request
GET /v5.0/dns_resolvers HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

Response
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
}

Dns resolver # Show

Path:
GET /v5.0/dns_resolvers/{dns_resolver_id}
Description:
Show DNS resolver
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
dns_resolver
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

Self-description

{
  "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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.0/locations?method=GET"
        }
      }
    },
    "layout": "object",
    "namespace": "dns_resolver"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/dns_resolvers/{dns_resolver_id}",
  "method": "GET",
  "help": "/v5.0/dns_resolvers/{dns_resolver_id}?method=GET"
}

Dns resolver # Update

Path:
PUT /v5.0/dns_resolvers/{dns_resolver_id}
Description:
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
dns_resolver
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

Output parameters

Layout:
object
Namespace:
dns_resolver
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

Self-description

{
  "auth": true,
  "description": null,
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "ip_addr": {
        "required": false,
        "label": "IP address",
        "description": "Multiple addresses separated by comma",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "is_universal": {
        "required": false,
        "label": "Is universal?",
        "description": "Universal resolver is independent on location",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "location": {
        "required": null,
        "label": "Location",
        "description": "Location this resolver can be used on",
        "type": "Resource",
        "resource": [
          "location"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.0/locations?method=GET"
        }
      }
    },
    "layout": "object",
    "namespace": "dns_resolver"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/dns_resolvers/{dns_resolver_id}",
  "method": "PUT",
  "help": "/v5.0/dns_resolvers/{dns_resolver_id}?method=PUT"
}

Environment


Manage environments

Environment # Create

Path:
POST /v5.0/environments
Description:
Create new environment
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
environment
Label Name Required Type Validators Default Description
Label label no String Environment label
Domain domain no String
Format
rx
[0-9a-zA-Z\-\.]{3,255}
match
true
description
message
invalid 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

Output parameters

Layout:
object
Namespace:
environment
Label Name Type Description
ID id Integer Environment ID
Label label String Environment label
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

Self-description

{
  "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
      },
      "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
      },
      "domain": {
        "required": false,
        "label": "Domain",
        "description": "Environment FQDN, should be subject's root domain",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "can_create_vps": {
        "required": false,
        "label": "Can create a VPS",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "can_destroy_vps": {
        "required": false,
        "label": "Can destroy a VPS",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "vps_lifetime": {
        "required": false,
        "label": "Default VPS lifetime",
        "description": "in seconds, 0 is unlimited",
        "type": "Integer",
        "validators": {
        },
        "default": 0,
        "protected": false
      },
      "max_vps_count": {
        "required": false,
        "label": "Maximum number of VPS per user",
        "description": "0 is unlimited",
        "type": "Integer",
        "validators": {
        },
        "default": 1,
        "protected": false
      },
      "user_ip_ownership": {
        "required": false,
        "label": "User owns IP addresses",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": true,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "environment"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [
    {
      "title": "",
      "comment": null,
      "path_params": null,
      "request": {
        "label": "Devel",
        "domain": "vpsfree.cz"
      },
      "response": {
        "id": 2
      },
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/environments",
  "method": "POST",
  "help": "/v5.0/environments?method=POST"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.environment.create({:label=>"Devel", :domain=>"vpsfree.cz"})

# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 2
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.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
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->environment->create([
  "label" => "Devel",
  "domain" => "vpsfree.cz"
]);

// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 2
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 environment create -- \
              --label 'Devel' \
              --domain 'vpsfree.cz'
                             ID:  2
                          Label:  -
                         Domain:  -
               Can create a VPS:  -
              Can destroy a VPS:  -
           Default VPS lifetime:  -
 Maximum number of VPS per user:  -
         User owns IP addresses:  -

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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
$ curl --request POST \
       --data-binary "{
  \"environment\": {
    \"label\": \"Devel\",
    \"domain\": \"vpsfree.cz\"
  }
}" \
       'http://api.vpsfree.cz/v5.0/environments'
Response
{
  "status": true,
  "message": null,
  "response": {
    "environment": {
      "id": 2
    }
  },
  "errors": null
}
HTTP
Request
POST /v5.0/environments HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

{
  "environment": {
    "label": "Devel",
    "domain": "vpsfree.cz"
  }
}
Response
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
}

Environment # Index

Path:
GET /v5.0/environments
Description:
List environments
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
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
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

Output parameters

Layout:
object_list
Namespace:
environments
Label Name Type Description
ID id Integer Environment ID
Label label String Environment label
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

Self-description

{
  "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
      },
      "domain": {
        "required": false,
        "label": "Domain",
        "description": "Environment FQDN, should be subject's root domain",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "can_create_vps": {
        "required": false,
        "label": "Can create a VPS",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "can_destroy_vps": {
        "required": false,
        "label": "Can destroy a VPS",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "vps_lifetime": {
        "required": false,
        "label": "Default VPS lifetime",
        "description": "in seconds, 0 is unlimited",
        "type": "Integer",
        "validators": {
        },
        "default": 0,
        "protected": false
      },
      "max_vps_count": {
        "required": false,
        "label": "Maximum number of VPS per user",
        "description": "0 is unlimited",
        "type": "Integer",
        "validators": {
        },
        "default": 1,
        "protected": false
      },
      "user_ip_ownership": {
        "required": false,
        "label": "User owns IP addresses",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": true,
        "protected": false
      },
      "maintenance_lock": {
        "required": false,
        "label": "Maintenance lock",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "no",
              "lock",
              "master_lock"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "maintenance_lock_reason": {
        "required": false,
        "label": "Maintenance reason",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "environments"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [
    {
      "title": "",
      "comment": null,
      "path_params": null,
      "request": {
      },
      "response": [
        {
          "id": 1,
          "label": "Production",
          "domain": "vpsfree.cz"
        }
      ],
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/environments",
  "method": "GET",
  "help": "/v5.0/environments?method=GET"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.environment.index

# reply is an instance of HaveAPI::Client::ResourceInstanceList,
# which is a subclass of Array
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});

api.environment.index(function (client, reply) {
  console.log('Response', reply);
  // reply is an instance of HaveAPI.Client.ResourceInstanceList
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->environment->index();

// $reply is an instance of \HaveAPI\Client\ResourceInstanceList
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 environment index
                             ID:  1
                          Label:  Production
                         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:  -

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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
$ curl --request GET \
       --data-binary "{
  \"environment\": {
  }
}" \
       'http://api.vpsfree.cz/v5.0/environments'
Response
{
  "status": true,
  "message": null,
  "response": {
    "environments": [
      {
        "id": 1,
        "label": "Production",
        "domain": "vpsfree.cz"
      }
    ]
  },
  "errors": null
}
HTTP
Request
GET /v5.0/environments HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

Response
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
}

Environment # Set_maintenance

Path:
POST /v5.0/environments/{environment_id}/set_maintenance
Description:
Set maintenance lock
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
hash
Namespace:
environment
Label Name Required Type Validators Default Description
Lock lock yes Boolean
Present
empty
false
message
must be present and non-empty
Reason reason no String

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Set maintenance lock",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "lock": {
        "required": true,
        "label": "Lock",
        "description": null,
        "type": "Boolean",
        "validators": {
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      },
      "reason": {
        "required": false,
        "label": "Reason",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": "",
        "protected": false
      }
    },
    "layout": "hash",
    "namespace": "environment"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "environment"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/environments/{environment_id}/set_maintenance",
  "method": "POST",
  "help": "/v5.0/environments/{environment_id}/set_maintenance?method=POST"
}

Environment # Show

Path:
GET /v5.0/environments/{environment_id}
Description:
Show environment
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
environment
Label Name Type Description
ID id Integer Environment ID
Label label String Environment label
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

Self-description

{
  "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
      },
      "domain": {
        "required": false,
        "label": "Domain",
        "description": "Environment FQDN, should be subject's root domain",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "can_create_vps": {
        "required": false,
        "label": "Can create a VPS",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "can_destroy_vps": {
        "required": false,
        "label": "Can destroy a VPS",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "vps_lifetime": {
        "required": false,
        "label": "Default VPS lifetime",
        "description": "in seconds, 0 is unlimited",
        "type": "Integer",
        "validators": {
        },
        "default": 0,
        "protected": false
      },
      "max_vps_count": {
        "required": false,
        "label": "Maximum number of VPS per user",
        "description": "0 is unlimited",
        "type": "Integer",
        "validators": {
        },
        "default": 1,
        "protected": false
      },
      "user_ip_ownership": {
        "required": false,
        "label": "User owns IP addresses",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": true,
        "protected": false
      },
      "maintenance_lock": {
        "required": false,
        "label": "Maintenance lock",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "no",
              "lock",
              "master_lock"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "maintenance_lock_reason": {
        "required": false,
        "label": "Maintenance reason",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "environment"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [
    {
      "title": "",
      "comment": null,
      "path_params": [
        1
      ],
      "request": {
      },
      "response": {
        "id": 1,
        "label": "Production",
        "domain": "vpsfree.cz"
      },
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/environments/{environment_id}",
  "method": "GET",
  "help": "/v5.0/environments/{environment_id}?method=GET"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.environment.show(1)

# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 1
# reply.label = "Production"
# reply.domain = "vpsfree.cz"
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.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"
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->environment->show(1);

// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 1
// $reply->label = "Production"
// $reply->domain = "vpsfree.cz"
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 environment show 1
                             ID:  1
                          Label:  Production
                         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:  -

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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
$ curl --request GET \
       --data-binary "{
  \"environment\": {
  }
}" \
       'http://api.vpsfree.cz/v5.0/environments/1'
Response
{
  "status": true,
  "message": null,
  "response": {
    "environment": {
      "id": 1,
      "label": "Production",
      "domain": "vpsfree.cz"
    }
  },
  "errors": null
}
HTTP
Request
GET /v5.0/environments/1 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

Response
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
}

Environment # Update

Path:
PUT /v5.0/environments/{environment_id}
Description:
Update environment
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
environment
Label Name Required Type Validators Default Description
Label label no String Environment label
Domain domain no String
Format
rx
[0-9a-zA-Z\-\.]{3,255}
match
true
description
message
invalid 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

Output parameters

Layout:
object
Namespace:
environment
Label Name Type Description
ID id Integer Environment ID
Label label String Environment label
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

Self-description

{
  "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
      },
      "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
      },
      "domain": {
        "required": false,
        "label": "Domain",
        "description": "Environment FQDN, should be subject's root domain",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "can_create_vps": {
        "required": false,
        "label": "Can create a VPS",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "can_destroy_vps": {
        "required": false,
        "label": "Can destroy a VPS",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": false,
        "protected": false
      },
      "vps_lifetime": {
        "required": false,
        "label": "Default VPS lifetime",
        "description": "in seconds, 0 is unlimited",
        "type": "Integer",
        "validators": {
        },
        "default": 0,
        "protected": false
      },
      "max_vps_count": {
        "required": false,
        "label": "Maximum number of VPS per user",
        "description": "0 is unlimited",
        "type": "Integer",
        "validators": {
        },
        "default": 1,
        "protected": false
      },
      "user_ip_ownership": {
        "required": false,
        "label": "User owns IP addresses",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": true,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "environment"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [
    {
      "title": "",
      "comment": null,
      "path_params": [
        1
      ],
      "request": {
        "label": "My new name",
        "domain": "new.domain"
      },
      "response": {
      },
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/environments/{environment_id}",
  "method": "PUT",
  "help": "/v5.0/environments/{environment_id}?method=PUT"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.environment.update(1, {:label=>"My new name", :domain=>"new.domain"})

# reply is an instance of HaveAPI::Client::ResourceInstance
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.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
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->environment->update(1, [
  "label" => "My new name",
  "domain" => "new.domain"
]);

// $reply is an instance of \HaveAPI\Client\ResourceInstance
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 environment update 1 -- \
              --label 'My new name' \
              --domain 'new.domain'
File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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
$ curl --request PUT \
       --data-binary "{
  \"environment\": {
    \"label\": \"My new name\",
    \"domain\": \"new.domain\"
  }
}" \
       'http://api.vpsfree.cz/v5.0/environments/1'
Response
{
  "status": true,
  "message": null,
  "response": {
    "environment": {
    }
  },
  "errors": null
}
HTTP
Request
PUT /v5.0/environments/1 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

{
  "environment": {
    "label": "My new name",
    "domain": "new.domain"
  }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 105

{
  "status": true,
  "message": null,
  "response": {
    "environment": {
    }
  },
  "errors": null
}

Config chain


Manage implicit VPS config chains

Environment.Config chain # Index

Path:
GET /v5.0/environments/{environment_id}/config_chains
Description:
List environment VPS config chain
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
config_chain
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

Output parameters

Layout:
object_list
Namespace:
config_chains
Label Name Type Description
VPS config vps_config Resource

Self-description

{
  "auth": true,
  "description": "List environment VPS config chain",
  "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": "config_chain"
  },
  "output": {
    "parameters": {
      "vps_config": {
        "required": null,
        "label": "VPS config",
        "description": null,
        "type": "Resource",
        "resource": [
          "vps_config"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/vps_configs",
          "method": "GET",
          "help": "/v5.0/vps_configs?method=GET"
        }
      }
    },
    "layout": "object_list",
    "namespace": "config_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": [

  ],
  "path": "/v5.0/environments/{environment_id}/config_chains",
  "method": "GET",
  "help": "/v5.0/environments/{environment_id}/config_chains?method=GET"
}

Environment.Config chain # Replace

Path:
POST /v5.0/environments/{environment_id}/config_chains/replace
Description:
Set complete config chain
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object_list
Namespace:
config_chains
Label Name Required Type Validators Default Description
VPS config vps_config yes Resource

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Set complete config chain",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "vps_config": {
        "required": true,
        "label": "VPS config",
        "description": null,
        "type": "Resource",
        "resource": [
          "vps_config"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/vps_configs",
          "method": "GET",
          "help": "/v5.0/vps_configs?method=GET"
        }
      }
    },
    "layout": "object_list",
    "namespace": "config_chains"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "config_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": [

  ],
  "path": "/v5.0/environments/{environment_id}/config_chains/replace",
  "method": "POST",
  "help": "/v5.0/environments/{environment_id}/config_chains/replace?method=POST"
}

Dataset plan


Manage environment dataset plans

Environment.Dataset plan # Index

Path:
GET /v5.0/environments/{environment_id}/dataset_plans
Description:
List dataset plans
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
dataset_plan
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

Output parameters

Layout:
object_list
Namespace:
dataset_plans
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

Self-description

{
  "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": "/v5.0/dataset_plans",
          "method": "GET",
          "help": "/v5.0/dataset_plans?method=GET"
        }
      },
      "user_add": {
        "required": false,
        "label": "User add",
        "description": "If true, the user can add this plan to a dataset",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_remove": {
        "required": false,
        "label": "User remove",
        "description": "If true, the user can remove this plan from a dataset",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "dataset_plans"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/environments/{environment_id}/dataset_plans",
  "method": "GET",
  "help": "/v5.0/environments/{environment_id}/dataset_plans?method=GET"
}

Environment.Dataset plan # Show

Path:
GET /v5.0/environments/{environment_id}/dataset_plans/{dataset_plan_id}
Description:
Show dataset plan
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
dataset_plan
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

Self-description

{
  "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": "/v5.0/dataset_plans",
          "method": "GET",
          "help": "/v5.0/dataset_plans?method=GET"
        }
      },
      "user_add": {
        "required": false,
        "label": "User add",
        "description": "If true, the user can add this plan to a dataset",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_remove": {
        "required": false,
        "label": "User remove",
        "description": "If true, the user can remove this plan from a dataset",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "dataset_plan"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/environments/{environment_id}/dataset_plans/{dataset_plan_id}",
  "method": "GET",
  "help": "/v5.0/environments/{environment_id}/dataset_plans/{dataset_plan_id}?method=GET"
}

Help box


Browse and manage help boxes

Help box # Create

Path:
POST /v5.0/help_boxes
Description:
Create a help box
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
help_box
Label Name Required Type Validators Default Description
Page page no String
Action action no String
Language language no Resource
Content content yes Text
Present
empty
false
message
must be present and non-empty
Order order no Integer

Output parameters

Layout:
object
Namespace:
help_box
Label Name Type Description
Id id Integer
Page page String
Action action String
Language language Resource
Content content Text
Order order Integer

Self-description

{
  "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": "/v5.0/languages",
          "method": "GET",
          "help": "/v5.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": "/v5.0/languages",
          "method": "GET",
          "help": "/v5.0/languages?method=GET"
        }
      },
      "content": {
        "required": false,
        "label": "Content",
        "description": null,
        "type": "Text",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "order": {
        "required": false,
        "label": "Order",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "help_box"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/help_boxes",
  "method": "POST",
  "help": "/v5.0/help_boxes?method=POST"
}

Help box # Delete

Path:
DELETE /v5.0/help_boxes/{help_box_id}
Description:
Delete help box
Authentication required:
yes
Aliases:
destroy
Blocking:
no

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "auth": true,
  "description": "Delete help box",
  "aliases": [
    "destroy"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "help_box"
  },
  "output": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "help_box"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/help_boxes/{help_box_id}",
  "method": "DELETE",
  "help": "/v5.0/help_boxes/{help_box_id}?method=DELETE"
}

Help box # Index

Path:
GET /v5.0/help_boxes
Description:
List help boxes
Authentication required:
no
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
help_box
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

Output parameters

Layout:
object_list
Namespace:
help_boxes
Label Name Type Description
Id id Integer
Page page String
Action action String
Language language Resource
Content content Text
Order order Integer

Self-description

{
  "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": "/v5.0/languages",
          "method": "GET",
          "help": "/v5.0/languages?method=GET"
        }
      }
    },
    "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": "/v5.0/languages",
          "method": "GET",
          "help": "/v5.0/languages?method=GET"
        }
      },
      "content": {
        "required": false,
        "label": "Content",
        "description": null,
        "type": "Text",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "order": {
        "required": false,
        "label": "Order",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "help_boxes"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/help_boxes",
  "method": "GET",
  "help": "/v5.0/help_boxes?method=GET"
}

Help box # Show

Path:
GET /v5.0/help_boxes/{help_box_id}
Description:
Show helpbox
Authentication required:
no
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
help_box
Label Name Type Description
Id id Integer
Page page String
Action action String
Language language Resource
Content content Text
Order order Integer

Self-description

{
  "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": "/v5.0/languages",
          "method": "GET",
          "help": "/v5.0/languages?method=GET"
        }
      },
      "content": {
        "required": false,
        "label": "Content",
        "description": null,
        "type": "Text",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "order": {
        "required": false,
        "label": "Order",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "help_box"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/help_boxes/{help_box_id}",
  "method": "GET",
  "help": "/v5.0/help_boxes/{help_box_id}?method=GET"
}

Help box # Update

Path:
PUT /v5.0/help_boxes/{help_box_id}
Description:
Update help box
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
help_box
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

Output parameters

Layout:
object
Namespace:
help_box
Label Name Type Description
Id id Integer
Page page String
Action action String
Language language Resource
Content content Text
Order order Integer

Self-description

{
  "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": "/v5.0/languages",
          "method": "GET",
          "help": "/v5.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": "/v5.0/languages",
          "method": "GET",
          "help": "/v5.0/languages?method=GET"
        }
      },
      "content": {
        "required": false,
        "label": "Content",
        "description": null,
        "type": "Text",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "order": {
        "required": false,
        "label": "Order",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "help_box"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/help_boxes/{help_box_id}",
  "method": "PUT",
  "help": "/v5.0/help_boxes/{help_box_id}?method=PUT"
}

Host ip address


Manage interface IP addresses

Host ip address # Assign

Path:
POST /v5.0/host_ip_addresses/{host_ip_address_id}/assign
Description:
Assign the address to an interface
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
host_ip_address
Label Name Type Description
ID id Integer IP address ID
IpAddress ip_address Resource
Address addr String Address itself
Assigned assigned Boolean

Self-description

{
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "addr": {
        "required": false,
        "label": "Address",
        "description": "Address itself",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "assigned": {
        "required": false,
        "label": "Assigned",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "host_ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/host_ip_addresses/{host_ip_address_id}/assign",
  "method": "POST",
  "help": "/v5.0/host_ip_addresses/{host_ip_address_id}/assign?method=POST"
}

Host ip address # Free

Path:
POST /v5.0/host_ip_addresses/{host_ip_address_id}/free
Description:
Remove the address from its interface
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
host_ip_address
Label Name Type Description
ID id Integer IP address ID
IpAddress ip_address Resource
Address addr String Address itself
Assigned assigned Boolean

Self-description

{
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "addr": {
        "required": false,
        "label": "Address",
        "description": "Address itself",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "assigned": {
        "required": false,
        "label": "Assigned",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "host_ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/host_ip_addresses/{host_ip_address_id}/free",
  "method": "POST",
  "help": "/v5.0/host_ip_addresses/{host_ip_address_id}/free?method=POST"
}

Host ip address # Index

Path:
GET /v5.0/host_ip_addresses
Description:
List IP addresses
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
host_ip_address
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
values
["public_access", "private_access"]
message
%{value} cannot be used
Address addr no String Address itself
Prefix prefix no Integer
Size size no Integer
Max tx max_tx no Integer Maximum output throughput
Max rx max_rx no Integer Maximum input throughput
Assigned assigned no Boolean

Output parameters

Layout:
object_list
Namespace:
host_ip_addresses
Label Name Type Description
ID id Integer IP address ID
IpAddress ip_address Resource
Address addr String Address itself
Assigned assigned Boolean

Self-description

{
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/vpses",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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
      },
      "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
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "assigned": {
        "required": false,
        "label": "Assigned",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "host_ip_address"
  },
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "addr": {
        "required": false,
        "label": "Address",
        "description": "Address itself",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "assigned": {
        "required": false,
        "label": "Assigned",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "host_ip_addresses"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/host_ip_addresses",
  "method": "GET",
  "help": "/v5.0/host_ip_addresses?method=GET"
}

Host ip address # Show

Path:
GET /v5.0/host_ip_addresses/{host_ip_address_id}
Description:
Show interface IP address
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
host_ip_address
Label Name Type Description
ID id Integer IP address ID
IpAddress ip_address Resource
Address addr String Address itself
Assigned assigned Boolean

Self-description

{
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "addr": {
        "required": false,
        "label": "Address",
        "description": "Address itself",
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "assigned": {
        "required": false,
        "label": "Assigned",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "host_ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/host_ip_addresses/{host_ip_address_id}",
  "method": "GET",
  "help": "/v5.0/host_ip_addresses/{host_ip_address_id}?method=GET"
}

Incoming payment


Browse incoming payments

Incoming payment # Index

Path:
GET /v5.0/incoming_payments
Description:
List incoming payments
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
incoming_payment
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
values
["queued", "unmatched", "processed", "ignored"]
message
%{value} cannot be used

Output parameters

Layout:
object_list
Namespace:
incoming_payments
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

Self-description

{
  "auth": true,
  "description": "List incoming payments",
  "aliases": [
    "list"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "offset": {
        "required": false,
        "label": "Offset",
        "description": "The offset of the first object",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "limit": {
        "required": false,
        "label": "Limit",
        "description": "The number of objects to retrieve",
        "type": "Integer",
        "validators": {
        },
        "default": 25,
        "protected": false
      },
      "state": {
        "required": false,
        "label": "State",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "queued",
              "unmatched",
              "processed",
              "ignored"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "incoming_payment"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "transaction_id": {
        "required": false,
        "label": "Transaction_id",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "state": {
        "required": false,
        "label": "State",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "queued",
              "unmatched",
              "processed",
              "ignored"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "date": {
        "required": false,
        "label": "Date",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "amount": {
        "required": false,
        "label": "Amount",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "currency": {
        "required": false,
        "label": "Currency",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "src_amount": {
        "required": false,
        "label": "Src_amount",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "src_currency": {
        "required": false,
        "label": "Src_currency",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "account_name": {
        "required": false,
        "label": "Account_name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_ident": {
        "required": false,
        "label": "User_ident",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_message": {
        "required": false,
        "label": "User_message",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vs": {
        "required": false,
        "label": "Vs",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ks": {
        "required": false,
        "label": "Ks",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ss": {
        "required": false,
        "label": "Ss",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "transaction_type": {
        "required": false,
        "label": "Transaction_type",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "comment": {
        "required": false,
        "label": "Comment",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "incoming_payments"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/incoming_payments",
  "method": "GET",
  "help": "/v5.0/incoming_payments?method=GET"
}

Incoming payment # Show

Path:
GET /v5.0/incoming_payments/{incoming_payment_id}
Description:
Show incoming payment
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
incoming_payment
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

Self-description

{
  "auth": true,
  "description": "Show incoming payment",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "incoming_payment"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "transaction_id": {
        "required": false,
        "label": "Transaction_id",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "state": {
        "required": false,
        "label": "State",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "queued",
              "unmatched",
              "processed",
              "ignored"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "date": {
        "required": false,
        "label": "Date",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "amount": {
        "required": false,
        "label": "Amount",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "currency": {
        "required": false,
        "label": "Currency",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "src_amount": {
        "required": false,
        "label": "Src_amount",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "src_currency": {
        "required": false,
        "label": "Src_currency",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "account_name": {
        "required": false,
        "label": "Account_name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_ident": {
        "required": false,
        "label": "User_ident",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_message": {
        "required": false,
        "label": "User_message",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vs": {
        "required": false,
        "label": "Vs",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ks": {
        "required": false,
        "label": "Ks",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ss": {
        "required": false,
        "label": "Ss",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "transaction_type": {
        "required": false,
        "label": "Transaction_type",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "comment": {
        "required": false,
        "label": "Comment",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "incoming_payment"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/incoming_payments/{incoming_payment_id}",
  "method": "GET",
  "help": "/v5.0/incoming_payments/{incoming_payment_id}?method=GET"
}

Incoming payment # Update

Path:
PUT /v5.0/incoming_payments/{incoming_payment_id}
Description:
Change payment's state
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
incoming_payment
Label Name Required Type Validators Default Description
State state yes String
Include
values
["queued", "unmatched", "processed", "ignored"]
message
%{value} cannot be used
Present
empty
false
message
must be present and non-empty

Output parameters

Layout:
object
Namespace:
incoming_payment
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

Self-description

{
  "auth": true,
  "description": "Change payment's state",
  "aliases": [

  ],
  "blocking": false,
  "input": {
    "parameters": {
      "state": {
        "required": true,
        "label": "State",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "queued",
              "unmatched",
              "processed",
              "ignored"
            ],
            "message": "%{value} cannot be used"
          },
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "incoming_payment"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "transaction_id": {
        "required": false,
        "label": "Transaction_id",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "state": {
        "required": false,
        "label": "State",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "queued",
              "unmatched",
              "processed",
              "ignored"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "date": {
        "required": false,
        "label": "Date",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "amount": {
        "required": false,
        "label": "Amount",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "currency": {
        "required": false,
        "label": "Currency",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "src_amount": {
        "required": false,
        "label": "Src_amount",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "src_currency": {
        "required": false,
        "label": "Src_currency",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "account_name": {
        "required": false,
        "label": "Account_name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_ident": {
        "required": false,
        "label": "User_ident",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "user_message": {
        "required": false,
        "label": "User_message",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vs": {
        "required": false,
        "label": "Vs",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ks": {
        "required": false,
        "label": "Ks",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "ss": {
        "required": false,
        "label": "Ss",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "transaction_type": {
        "required": false,
        "label": "Transaction_type",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "comment": {
        "required": false,
        "label": "Comment",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "incoming_payment"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/incoming_payments/{incoming_payment_id}",
  "method": "PUT",
  "help": "/v5.0/incoming_payments/{incoming_payment_id}?method=PUT"
}

Integrity check


Schedule integrity checks and view results

Integrity check # Create

Path:
POST /v5.0/integrity_checks
Description:
Schedule a new cluster-wide integrity check
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
integrity_check
Label Name Required Type Validators Default Description
Node node no Resource
Storage storage no Boolean
Vps vps no Boolean
Skip_maintenance skip_maintenance no Boolean

Output parameters

Layout:
object
Namespace:
integrity_check
Label Name Type Description
Id id Integer
Status status String
User user Resource
Checked_objects checked_objects Integer
Integral_objects integral_objects Integer
Broken_objects broken_objects Integer
Checked_facts checked_facts Integer
True_facts true_facts Integer
False_facts false_facts Integer
Created_at created_at Datetime
Updated_at updated_at Datetime
Finished_at finished_at Datetime

Self-description

{
  "auth": true,
  "description": "Schedule a new cluster-wide integrity check",
  "aliases": [
    "new"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "node": {
        "required": null,
        "label": "Node",
        "description": null,
        "type": "Resource",
        "resource": [
          "node"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/nodes",
          "method": "GET",
          "help": "/v5.0/nodes?method=GET"
        }
      },
      "storage": {
        "required": false,
        "label": "Storage",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps": {
        "required": false,
        "label": "Vps",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "skip_maintenance": {
        "required": false,
        "label": "Skip_maintenance",
        "description": null,
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "integrity_check"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "pending",
              "integral",
              "broken"
            ],
            "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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "checked_objects": {
        "required": false,
        "label": "Checked_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "integral_objects": {
        "required": false,
        "label": "Integral_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "broken_objects": {
        "required": false,
        "label": "Broken_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "checked_facts": {
        "required": false,
        "label": "Checked_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "true_facts": {
        "required": false,
        "label": "True_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "false_facts": {
        "required": false,
        "label": "False_facts",
        "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
      },
      "finished_at": {
        "required": false,
        "label": "Finished_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "integrity_check"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/integrity_checks",
  "method": "POST",
  "help": "/v5.0/integrity_checks?method=POST"
}

Integrity check # Index

Path:
GET /v5.0/integrity_checks
Description:
List integrity checks
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
integrity_check
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
Status status no String
Include
values
["pending", "integral", "broken"]
message
%{value} cannot be used
User user no Resource

Output parameters

Layout:
object_list
Namespace:
integrity_checks
Label Name Type Description
Id id Integer
Status status String
User user Resource
Checked_objects checked_objects Integer
Integral_objects integral_objects Integer
Broken_objects broken_objects Integer
Checked_facts checked_facts Integer
True_facts true_facts Integer
False_facts false_facts Integer
Created_at created_at Datetime
Updated_at updated_at Datetime
Finished_at finished_at Datetime

Self-description

{
  "auth": true,
  "description": "List integrity checks",
  "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
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "pending",
              "integral",
              "broken"
            ],
            "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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      }
    },
    "layout": "object",
    "namespace": "integrity_check"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "pending",
              "integral",
              "broken"
            ],
            "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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "checked_objects": {
        "required": false,
        "label": "Checked_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "integral_objects": {
        "required": false,
        "label": "Integral_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "broken_objects": {
        "required": false,
        "label": "Broken_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "checked_facts": {
        "required": false,
        "label": "Checked_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "true_facts": {
        "required": false,
        "label": "True_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "false_facts": {
        "required": false,
        "label": "False_facts",
        "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
      },
      "finished_at": {
        "required": false,
        "label": "Finished_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "integrity_checks"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/integrity_checks",
  "method": "GET",
  "help": "/v5.0/integrity_checks?method=GET"
}

Integrity check # Show

Path:
GET /v5.0/integrity_checks/{integrity_check_id}
Description:
Show an integrity check
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
integrity_check
Label Name Type Description
Id id Integer
Status status String
User user Resource
Checked_objects checked_objects Integer
Integral_objects integral_objects Integer
Broken_objects broken_objects Integer
Checked_facts checked_facts Integer
True_facts true_facts Integer
False_facts false_facts Integer
Created_at created_at Datetime
Updated_at updated_at Datetime
Finished_at finished_at Datetime

Self-description

{
  "auth": true,
  "description": "Show an integrity check",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "integrity_check"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "pending",
              "integral",
              "broken"
            ],
            "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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "checked_objects": {
        "required": false,
        "label": "Checked_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "integral_objects": {
        "required": false,
        "label": "Integral_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "broken_objects": {
        "required": false,
        "label": "Broken_objects",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "checked_facts": {
        "required": false,
        "label": "Checked_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "true_facts": {
        "required": false,
        "label": "True_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "false_facts": {
        "required": false,
        "label": "False_facts",
        "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
      },
      "finished_at": {
        "required": false,
        "label": "Finished_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "integrity_check"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/integrity_checks/{integrity_check_id}",
  "method": "GET",
  "help": "/v5.0/integrity_checks/{integrity_check_id}?method=GET"
}

Integrity fact


View checked facts of integrity objects

Integrity fact # Index

Path:
GET /v5.0/integrity_facts
Description:
List checked facts
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
integrity_fact
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
IntegrityCheck integrity_check no Resource
Node node no Resource
Class_name class_name no String
IntegrityObject integrity_object no Resource
Name name no String
Status status no String
Include
values
["false", "true"]
message
%{value} cannot be used
Severity severity no String
Include
values
["low", "normal", "high"]
message
%{value} cannot be used

Output parameters

Layout:
object_list
Namespace:
integrity_facts
Label Name Type Description
Id id Integer
IntegrityObject integrity_object Resource
Name name String
Expected_value expected_value Custom
Actual_value actual_value Custom
Status status String
Severity severity String
Message message String
Created_at created_at Datetime

Self-description

{
  "auth": true,
  "description": "List checked facts",
  "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
      },
      "integrity_check": {
        "required": null,
        "label": "IntegrityCheck",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_check"
        ],
        "value_id": "id",
        "value_label": "created_at",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_checks",
          "method": "GET",
          "help": "/v5.0/integrity_checks?method=GET"
        }
      },
      "node": {
        "required": null,
        "label": "Node",
        "description": null,
        "type": "Resource",
        "resource": [
          "node"
        ],
        "value_id": "id",
        "value_label": "name",
        "value": null,
        "choices": {
          "path": "/v5.0/nodes",
          "method": "GET",
          "help": "/v5.0/nodes?method=GET"
        }
      },
      "class_name": {
        "required": false,
        "label": "Class_name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "integrity_object": {
        "required": null,
        "label": "IntegrityObject",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_object"
        ],
        "value_id": "id",
        "value_label": "class_name",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_objects",
          "method": "GET",
          "help": "/v5.0/integrity_objects?method=GET"
        }
      },
      "name": {
        "required": false,
        "label": "Name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "false",
              "true"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "severity": {
        "required": false,
        "label": "Severity",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "low",
              "normal",
              "high"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "integrity_fact"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "integrity_object": {
        "required": null,
        "label": "IntegrityObject",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_object"
        ],
        "value_id": "id",
        "value_label": "class_name",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_objects",
          "method": "GET",
          "help": "/v5.0/integrity_objects?method=GET"
        }
      },
      "name": {
        "required": false,
        "label": "Name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "expected_value": {
        "required": false,
        "label": "Expected_value",
        "description": null,
        "type": "Custom",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "actual_value": {
        "required": false,
        "label": "Actual_value",
        "description": null,
        "type": "Custom",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "false",
              "true"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "severity": {
        "required": false,
        "label": "Severity",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "low",
              "normal",
              "high"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "message": {
        "required": false,
        "label": "Message",
        "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": "integrity_facts"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/integrity_facts",
  "method": "GET",
  "help": "/v5.0/integrity_facts?method=GET"
}

Integrity fact # Show

Path:
GET /v5.0/integrity_facts/{integrity_fact_id}
Description:
Show a checked fact
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
integrity_fact
Label Name Type Description
Id id Integer
IntegrityObject integrity_object Resource
Name name String
Expected_value expected_value Custom
Actual_value actual_value Custom
Status status String
Severity severity String
Message message String
Created_at created_at Datetime

Self-description

{
  "auth": true,
  "description": "Show a checked fact",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "integrity_fact"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "integrity_object": {
        "required": null,
        "label": "IntegrityObject",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_object"
        ],
        "value_id": "id",
        "value_label": "class_name",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_objects",
          "method": "GET",
          "help": "/v5.0/integrity_objects?method=GET"
        }
      },
      "name": {
        "required": false,
        "label": "Name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "expected_value": {
        "required": false,
        "label": "Expected_value",
        "description": null,
        "type": "Custom",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "actual_value": {
        "required": false,
        "label": "Actual_value",
        "description": null,
        "type": "Custom",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "false",
              "true"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "severity": {
        "required": false,
        "label": "Severity",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "low",
              "normal",
              "high"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "message": {
        "required": false,
        "label": "Message",
        "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": "integrity_fact"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/integrity_facts/{integrity_fact_id}",
  "method": "GET",
  "help": "/v5.0/integrity_facts/{integrity_fact_id}?method=GET"
}

Integrity object


View objects whose integrity is checked

Integrity object # Index

Path:
GET /v5.0/integrity_objects
Description:
List integrity objects
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
integrity_object
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
IntegrityCheck integrity_check no Resource
Node node no Resource
Class_name class_name no String
Row_id row_id no Integer
Parent parent no Resource
Status status no String
Include
values
["undetermined", "integral", "broken"]
message
%{value} cannot be used

Output parameters

Layout:
object_list
Namespace:
integrity_objects
Label Name Type Description
Id id Integer
IntegrityCheck integrity_check Resource
Node node Resource
Class_name class_name String
Row_id row_id Integer
Parent parent Resource
Status status String
Checked_facts checked_facts Integer
True_facts true_facts Integer
False_facts false_facts Integer
Created_at created_at Datetime
Updated_at updated_at Datetime

Self-description

{
  "auth": true,
  "description": "List integrity objects",
  "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
      },
      "integrity_check": {
        "required": null,
        "label": "IntegrityCheck",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_check"
        ],
        "value_id": "id",
        "value_label": "created_at",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_checks",
          "method": "GET",
          "help": "/v5.0/integrity_checks?method=GET"
        }
      },
      "node": {
        "required": null,
        "label": "Node",
        "description": null,
        "type": "Resource",
        "resource": [
          "node"
        ],
        "value_id": "id",
        "value_label": "name",
        "value": null,
        "choices": {
          "path": "/v5.0/nodes",
          "method": "GET",
          "help": "/v5.0/nodes?method=GET"
        }
      },
      "class_name": {
        "required": false,
        "label": "Class_name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "row_id": {
        "required": false,
        "label": "Row_id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "parent": {
        "required": null,
        "label": "Parent",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_object"
        ],
        "value_id": "id",
        "value_label": "class_name",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_objects",
          "method": "GET",
          "help": "/v5.0/integrity_objects?method=GET"
        }
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "undetermined",
              "integral",
              "broken"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "integrity_object"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "integrity_check": {
        "required": null,
        "label": "IntegrityCheck",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_check"
        ],
        "value_id": "id",
        "value_label": "created_at",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_checks",
          "method": "GET",
          "help": "/v5.0/integrity_checks?method=GET"
        }
      },
      "node": {
        "required": null,
        "label": "Node",
        "description": null,
        "type": "Resource",
        "resource": [
          "node"
        ],
        "value_id": "id",
        "value_label": "name",
        "value": null,
        "choices": {
          "path": "/v5.0/nodes",
          "method": "GET",
          "help": "/v5.0/nodes?method=GET"
        }
      },
      "class_name": {
        "required": false,
        "label": "Class_name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "row_id": {
        "required": false,
        "label": "Row_id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "parent": {
        "required": null,
        "label": "Parent",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_object"
        ],
        "value_id": "id",
        "value_label": "class_name",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_objects",
          "method": "GET",
          "help": "/v5.0/integrity_objects?method=GET"
        }
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "undetermined",
              "integral",
              "broken"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "checked_facts": {
        "required": false,
        "label": "Checked_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "true_facts": {
        "required": false,
        "label": "True_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "false_facts": {
        "required": false,
        "label": "False_facts",
        "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": "integrity_objects"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/integrity_objects",
  "method": "GET",
  "help": "/v5.0/integrity_objects?method=GET"
}

Integrity object # Show

Path:
GET /v5.0/integrity_objects/{integrity_object_id}
Description:
Show an integrity object
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
integrity_object
Label Name Type Description
Id id Integer
IntegrityCheck integrity_check Resource
Node node Resource
Class_name class_name String
Row_id row_id Integer
Parent parent Resource
Status status String
Checked_facts checked_facts Integer
True_facts true_facts Integer
False_facts false_facts Integer
Created_at created_at Datetime
Updated_at updated_at Datetime

Self-description

{
  "auth": true,
  "description": "Show an integrity object",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "integrity_object"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "integrity_check": {
        "required": null,
        "label": "IntegrityCheck",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_check"
        ],
        "value_id": "id",
        "value_label": "created_at",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_checks",
          "method": "GET",
          "help": "/v5.0/integrity_checks?method=GET"
        }
      },
      "node": {
        "required": null,
        "label": "Node",
        "description": null,
        "type": "Resource",
        "resource": [
          "node"
        ],
        "value_id": "id",
        "value_label": "name",
        "value": null,
        "choices": {
          "path": "/v5.0/nodes",
          "method": "GET",
          "help": "/v5.0/nodes?method=GET"
        }
      },
      "class_name": {
        "required": false,
        "label": "Class_name",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "row_id": {
        "required": false,
        "label": "Row_id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "parent": {
        "required": null,
        "label": "Parent",
        "description": null,
        "type": "Resource",
        "resource": [
          "integrity_object"
        ],
        "value_id": "id",
        "value_label": "class_name",
        "value": null,
        "choices": {
          "path": "/v5.0/integrity_objects",
          "method": "GET",
          "help": "/v5.0/integrity_objects?method=GET"
        }
      },
      "status": {
        "required": false,
        "label": "Status",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "undetermined",
              "integral",
              "broken"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "checked_facts": {
        "required": false,
        "label": "Checked_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "true_facts": {
        "required": false,
        "label": "True_facts",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "false_facts": {
        "required": false,
        "label": "False_facts",
        "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": "integrity_object"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/integrity_objects/{integrity_object_id}",
  "method": "GET",
  "help": "/v5.0/integrity_objects/{integrity_object_id}?method=GET"
}

Ip address


Manage IP addresses

Ip address # Assign

Path:
POST /v5.0/ip_addresses/{ip_address_id}/assign
Description:
Route the address to an interface
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

Layout:
object
Namespace:
ip_address
Label Name Required Type Validators Default Description
NetworkInterface network_interface yes Resource
Route_via route_via no Resource

Output parameters

Layout:
object
Namespace:
ip_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
Max tx max_tx Integer Maximum output throughput
Max rx max_rx Integer Maximum input throughput
Class id class_id Integer Class id for shaper

Self-description

{
  "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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.0/host_ip_addresses?method=GET"
        }
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "class_id": {
        "required": false,
        "label": "Class id",
        "description": "Class id for shaper",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_addresses/{ip_address_id}/assign",
  "method": "POST",
  "help": "/v5.0/ip_addresses/{ip_address_id}/assign?method=POST"
}

Ip address # Assign_with_host_address

Path:
POST /v5.0/ip_addresses/{ip_address_id}/assign_with_host_address
Description:
Route the address to an interface
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

Layout:
object
Namespace:
ip_address
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

Output parameters

Layout:
object
Namespace:
ip_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
Max tx max_tx Integer Maximum output throughput
Max rx max_rx Integer Maximum input throughput
Class id class_id Integer Class id for shaper

Self-description

{
  "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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.0/host_ip_addresses?method=GET"
        }
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "class_id": {
        "required": false,
        "label": "Class id",
        "description": "Class id for shaper",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_addresses/{ip_address_id}/assign_with_host_address",
  "method": "POST",
  "help": "/v5.0/ip_addresses/{ip_address_id}/assign_with_host_address?method=POST"
}

Ip address # Create

Path:
POST /v5.0/ip_addresses
Description:
Add an IP address
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
ip_address
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
empty
false
message
must be present and non-empty
Address itself
Prefix prefix no Integer
Size size no Integer
Route_via route_via no Resource
Max tx max_tx no Integer Maximum output throughput
Max rx max_rx no Integer Maximum input throughput

Output parameters

Layout:
object
Namespace:
ip_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
Max tx max_tx Integer Maximum output throughput
Max rx max_rx Integer Maximum input throughput
Class id class_id Integer Class id for shaper

Self-description

{
  "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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.0/host_ip_addresses?method=GET"
        }
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.0/host_ip_addresses?method=GET"
        }
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "class_id": {
        "required": false,
        "label": "Class id",
        "description": "Class id for shaper",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_addresses",
  "method": "POST",
  "help": "/v5.0/ip_addresses?method=POST"
}

Ip address # Free

Path:
POST /v5.0/ip_addresses/{ip_address_id}/free
Description:
Remove the route from an interface
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
ip_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
Max tx max_tx Integer Maximum output throughput
Max rx max_rx Integer Maximum input throughput
Class id class_id Integer Class id for shaper

Self-description

{
  "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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.0/host_ip_addresses?method=GET"
        }
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "class_id": {
        "required": false,
        "label": "Class id",
        "description": "Class id for shaper",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_addresses/{ip_address_id}/free",
  "method": "POST",
  "help": "/v5.0/ip_addresses/{ip_address_id}/free?method=POST"
}

Ip address # Index

Path:
GET /v5.0/ip_addresses
Description:
List IP addresses
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
ip_address
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
Role role no String
Include
values
["public_access", "private_access"]
message
%{value} cannot be used
Address addr no String Address itself
Prefix prefix no Integer
Size size no Integer
Max tx max_tx no Integer Maximum output throughput
Max rx max_rx no Integer Maximum input throughput

Output parameters

Layout:
object_list
Namespace:
ip_addresses
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
Max tx max_tx Integer Maximum output throughput
Max rx max_rx Integer Maximum input throughput
Class id class_id Integer Class id for shaper

Self-description

{
  "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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/vpses",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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
      },
      "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
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.0/host_ip_addresses?method=GET"
        }
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "class_id": {
        "required": false,
        "label": "Class id",
        "description": "Class id for shaper",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "ip_addresses"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [
    {
      "title": "",
      "comment": "List IP addresses assigned to VPS with ID 101.",
      "path_params": null,
      "request": {
        "vps": 101
      },
      "response": [
        {
          "id": 10,
          "addr": "192.168.0.50"
        }
      ],
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/ip_addresses",
  "method": "GET",
  "help": "/v5.0/ip_addresses?method=GET"
}

Examples

Example #0

List IP addresses assigned to VPS with ID 101.

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.ip_address.index({:vps=>101})

# reply is an instance of HaveAPI::Client::ResourceInstanceList,
# which is a subclass of Array
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});

api.ip_address.index({
  "vps": 101
}, function (client, reply) {
  console.log('Response', reply);
  // reply is an instance of HaveAPI.Client.ResourceInstanceList
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->ip_address->index([
  "vps" => 101
]);

// $reply is an instance of \HaveAPI\Client\ResourceInstanceList
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 ip_address index -- \
              --vps '101'
               ID:  10
 NetworkInterface:  -
          Network:  -
             User:  -
          Address:  192.168.0.50
           Prefix:  -
             Size:  -
        Route_via:  -
           Max tx:  -
           Max rx:  -
         Class id:  -

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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
$ curl --request GET \
       --data-binary "{
  \"ip_address\": {
    \"vps\": 101
  }
}" \
       'http://api.vpsfree.cz/v5.0/ip_addresses?vps=101'
Response
{
  "status": true,
  "message": null,
  "response": {
    "ip_addresses": [
      {
        "id": 10,
        "addr": "192.168.0.50"
      }
    ]
  },
  "errors": null
}
HTTP
Request
GET /v5.0/ip_addresses?vps=101 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

Response
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
}

Ip address # Show

Path:
GET /v5.0/ip_addresses/{ip_address_id}
Description:
Show IP address
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
ip_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
Max tx max_tx Integer Maximum output throughput
Max rx max_rx Integer Maximum input throughput
Class id class_id Integer Class id for shaper

Self-description

{
  "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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.0/host_ip_addresses?method=GET"
        }
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "class_id": {
        "required": false,
        "label": "Class id",
        "description": "Class id for shaper",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_addresses/{ip_address_id}",
  "method": "GET",
  "help": "/v5.0/ip_addresses/{ip_address_id}?method=GET"
}

Ip address # Update

Path:
PUT /v5.0/ip_addresses/{ip_address_id}
Description:
Update IP address
Authentication required:
yes
Aliases:
Blocking:
yes

Input parameters

Layout:
object
Namespace:
ip_address
Label Name Required Type Validators Default Description
Max tx max_tx no Integer Maximum output throughput
Max rx max_rx no Integer Maximum input throughput
User user no Resource

Output parameters

Layout:
object
Namespace:
ip_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
Max tx max_tx Integer Maximum output throughput
Max rx max_rx Integer Maximum input throughput
Class id class_id Integer Class id for shaper

Self-description

{
  "auth": true,
  "description": "Update IP address",
  "aliases": [

  ],
  "blocking": true,
  "input": {
    "parameters": {
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?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": "/v5.0/network_interfaces",
          "method": "GET",
          "help": "/v5.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": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/host_ip_addresses",
          "method": "GET",
          "help": "/v5.0/host_ip_addresses?method=GET"
        }
      },
      "max_tx": {
        "required": false,
        "label": "Max tx",
        "description": "Maximum output throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "max_rx": {
        "required": false,
        "label": "Max rx",
        "description": "Maximum input throughput",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "class_id": {
        "required": false,
        "label": "Class id",
        "description": "Class id for shaper",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_address"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "action_state_id": {
            "required": false,
            "label": "Action state ID",
            "description": "ID of ActionState object for state querying. When null, the action is not blocking for the current invocation.",
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_addresses/{ip_address_id}",
  "method": "PUT",
  "help": "/v5.0/ip_addresses/{ip_address_id}?method=PUT"
}

Ip traffic


Browse IP traffic records

Ip traffic # Index

Path:
GET /v5.0/ip_traffics
Description:
List IP traffic
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
ip_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
IpAddress ip_address no Resource
User user no Resource
Role role no String
Include
values
["public", "private"]
message
%{value} cannot be used
Protocol protocol no String
Include
values
["all", "tcp", "udp", "other", "sum"]
message
%{value} cannot be used
Ip_version ip_version no Integer
Include
values
[4, 6]
message
%{value} cannot be used
Environment environment no Resource
Location location no Resource
Network network 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
Accumulate accumulate yes String
Include
values
["monthly"]
message
%{value} cannot be used
Present
empty
false
message
must be present and non-empty
Order order no String
Include
values
["created_at", "descending", "ascending"]
message
%{value} cannot be used
created_at

Output parameters

Layout:
object_list
Namespace:
ip_traffics
Label Name Type Description
Id id Integer
IpAddress ip_address Resource
User user Resource
Role role String
Protocol protocol String
Packets_in packets_in Integer
Packets_out packets_out Integer
Bytes_in bytes_in Integer
Bytes_out bytes_out Integer
Created_at created_at Datetime

Self-description

{
  "auth": true,
  "description": "List IP 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
      },
      "ip_address": {
        "required": null,
        "label": "IpAddress",
        "description": null,
        "type": "Resource",
        "resource": [
          "ip_address"
        ],
        "value_id": "id",
        "value_label": "addr",
        "value": null,
        "choices": {
          "path": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "user": {
        "required": null,
        "label": "User",
        "description": null,
        "type": "Resource",
        "resource": [
          "user"
        ],
        "value_id": "id",
        "value_label": "login",
        "value": null,
        "choices": {
          "path": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "role": {
        "required": false,
        "label": "Role",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "public",
              "private"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "protocol": {
        "required": false,
        "label": "Protocol",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "all",
              "tcp",
              "udp",
              "other",
              "sum"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "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
      },
      "environment": {
        "required": null,
        "label": "Environment",
        "description": null,
        "type": "Resource",
        "resource": [
          "environment"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.0/locations?method=GET"
        }
      },
      "network": {
        "required": null,
        "label": "Network",
        "description": null,
        "type": "Resource",
        "resource": [
          "network"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.0/networks?method=GET"
        }
      },
      "node": {
        "required": null,
        "label": "Node",
        "description": null,
        "type": "Resource",
        "resource": [
          "node"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/nodes",
          "method": "GET",
          "help": "/v5.0/nodes?method=GET"
        }
      },
      "vps": {
        "required": null,
        "label": "VPS",
        "description": null,
        "type": "Resource",
        "resource": [
          "vps"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/vpses",
          "method": "GET",
          "help": "/v5.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
      },
      "accumulate": {
        "required": true,
        "label": "Accumulate",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "monthly"
            ],
            "message": "%{value} cannot be used"
          },
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      },
      "order": {
        "required": false,
        "label": "Order",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "created_at",
              "descending",
              "ascending"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": "created_at",
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_traffic"
  },
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "user": {
        "required": null,
        "label": "User",
        "description": null,
        "type": "Resource",
        "resource": [
          "user"
        ],
        "value_id": "id",
        "value_label": "login",
        "value": null,
        "choices": {
          "path": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "role": {
        "required": false,
        "label": "Role",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "public",
              "private"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "protocol": {
        "required": false,
        "label": "Protocol",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "all",
              "tcp",
              "udp",
              "other",
              "sum"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "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
      },
      "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
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "ip_traffics"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_traffics",
  "method": "GET",
  "help": "/v5.0/ip_traffics?method=GET"
}

Ip traffic # Show

Path:
GET /v5.0/ip_traffics/{ip_traffic_id}
Description:
Show an IP traffic record
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
ip_traffic
Label Name Type Description
Id id Integer
IpAddress ip_address Resource
User user Resource
Role role String
Protocol protocol String
Packets_in packets_in Integer
Packets_out packets_out Integer
Bytes_in bytes_in Integer
Bytes_out bytes_out Integer
Created_at created_at Datetime

Self-description

{
  "auth": true,
  "description": "Show an IP traffic record",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "ip_traffic"
  },
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "user": {
        "required": null,
        "label": "User",
        "description": null,
        "type": "Resource",
        "resource": [
          "user"
        ],
        "value_id": "id",
        "value_label": "login",
        "value": null,
        "choices": {
          "path": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "role": {
        "required": false,
        "label": "Role",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "public",
              "private"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "protocol": {
        "required": false,
        "label": "Protocol",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "all",
              "tcp",
              "udp",
              "other",
              "sum"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "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
      },
      "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
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_traffic"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_traffics/{ip_traffic_id}",
  "method": "GET",
  "help": "/v5.0/ip_traffics/{ip_traffic_id}?method=GET"
}

Ip traffic # User_top

Path:
GET /v5.0/ip_traffics/user_top
Description:
Summed users' traffic
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
ip_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
Role role no String
Include
values
["public", "private"]
message
%{value} cannot be used
Protocol protocol no String
Include
values
["all", "tcp", "udp", "other"]
message
%{value} cannot be used
Ip_version ip_version no Integer
Include
values
[4, 6]
message
%{value} cannot be used
Environment environment no Resource
Location location no Resource
Network network no Resource
Node node no Resource
Year year no Integer
Month month no Integer
From from no Datetime
To to no Datetime
Accumulate accumulate yes String
Include
values
["monthly"]
message
%{value} cannot be used
Present
empty
false
message
must be present and non-empty

Output parameters

Layout:
object_list
Namespace:
ip_traffics
Label Name Type Description
User user Resource
Packets_in packets_in Integer
Packets_out packets_out Integer
Bytes_in bytes_in Integer
Bytes_out bytes_out Integer
Created_at created_at Datetime

Self-description

{
  "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
      },
      "role": {
        "required": false,
        "label": "Role",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "public",
              "private"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "default": null,
        "protected": false
      },
      "protocol": {
        "required": false,
        "label": "Protocol",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "all",
              "tcp",
              "udp",
              "other"
            ],
            "message": "%{value} cannot be used"
          }
        },
        "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
      },
      "environment": {
        "required": null,
        "label": "Environment",
        "description": null,
        "type": "Resource",
        "resource": [
          "environment"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.0/locations?method=GET"
        }
      },
      "network": {
        "required": null,
        "label": "Network",
        "description": null,
        "type": "Resource",
        "resource": [
          "network"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.0/networks?method=GET"
        }
      },
      "node": {
        "required": null,
        "label": "Node",
        "description": null,
        "type": "Resource",
        "resource": [
          "node"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/nodes",
          "method": "GET",
          "help": "/v5.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
      },
      "accumulate": {
        "required": true,
        "label": "Accumulate",
        "description": null,
        "type": "String",
        "validators": {
          "include": {
            "values": [
              "monthly"
            ],
            "message": "%{value} cannot be used"
          },
          "present": {
            "empty": false,
            "message": "must be present and non-empty"
          }
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_traffic"
  },
  "output": {
    "parameters": {
      "user": {
        "required": null,
        "label": "User",
        "description": null,
        "type": "Resource",
        "resource": [
          "user"
        ],
        "value_id": "id",
        "value_label": "login",
        "value": null,
        "choices": {
          "path": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "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
      },
      "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
      },
      "created_at": {
        "required": false,
        "label": "Created_at",
        "description": null,
        "type": "Datetime",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "ip_traffics"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/ip_traffics/user_top",
  "method": "GET",
  "help": "/v5.0/ip_traffics/user_top?method=GET"
}

Ip traffic monitor


View current IP traffic

Ip traffic monitor # Index

Path:
GET /v5.0/ip_traffic_monitors
Description:
List current IP traffic
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
ip_traffic_monitor
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
IpAddress ip_address no Resource
User user no Resource
Ip_version ip_version no Integer
Include
values
[4, 6]
message
%{value} cannot be used
Environment environment no Resource
Location location no Resource
Network network no Resource
Node node no Resource
VPS vps no Resource
Order order no String -bytes

Output parameters

Layout:
object_list
Namespace:
ip_traffic_monitors
Label Name Type Description
Id id Integer
IpAddress ip_address Resource
User user Resource
Packets packets Integer
Packets_in packets_in Integer
Packets_out packets_out Integer
Bytes bytes Integer
Bytes_in bytes_in Integer
Bytes_out bytes_out Integer
Public_packets public_packets Integer
Public_packets_in public_packets_in Integer
Public_packets_out public_packets_out Integer
Public_bytes public_bytes Integer
Public_bytes_in public_bytes_in Integer
Public_bytes_out public_bytes_out Integer
Public_tcp_packets public_tcp_packets Integer
Public_tcp_packets_in public_tcp_packets_in Integer
Public_tcp_packets_out public_tcp_packets_out Integer
Public_tcp_bytes public_tcp_bytes Integer
Public_tcp_bytes_in public_tcp_bytes_in Integer
Public_tcp_bytes_out public_tcp_bytes_out Integer
Public_udp_packets public_udp_packets Integer
Public_udp_packets_in public_udp_packets_in Integer
Public_udp_packets_out public_udp_packets_out Integer
Public_udp_bytes public_udp_bytes Integer
Public_udp_bytes_in public_udp_bytes_in Integer
Public_udp_bytes_out public_udp_bytes_out Integer
Public_other_packets public_other_packets Integer
Public_other_packets_in public_other_packets_in Integer
Public_other_packets_out public_other_packets_out Integer
Public_other_bytes public_other_bytes Integer
Public_other_bytes_in public_other_bytes_in Integer
Public_other_bytes_out public_other_bytes_out Integer
Private_packets private_packets Integer
Private_packets_in private_packets_in Integer
Private_packets_out private_packets_out Integer
Private_bytes private_bytes Integer
Private_bytes_in private_bytes_in Integer
Private_bytes_out private_bytes_out Integer
Private_tcp_packets private_tcp_packets Integer
Private_tcp_packets_in private_tcp_packets_in Integer
Private_tcp_packets_out private_tcp_packets_out Integer
Private_tcp_bytes private_tcp_bytes Integer
Private_tcp_bytes_in private_tcp_bytes_in Integer
Private_tcp_bytes_out private_tcp_bytes_out Integer
Private_udp_packets private_udp_packets Integer
Private_udp_packets_in private_udp_packets_in Integer
Private_udp_packets_out private_udp_packets_out Integer
Private_udp_bytes private_udp_bytes Integer
Private_udp_bytes_in private_udp_bytes_in Integer
Private_udp_bytes_out private_udp_bytes_out Integer
Private_other_packets private_other_packets Integer
Private_other_packets_in private_other_packets_in Integer
Private_other_packets_out private_other_packets_out Integer
Private_other_bytes private_other_bytes Integer
Private_other_bytes_in private_other_bytes_in Integer
Private_other_bytes_out private_other_bytes_out Integer
Updated_at updated_at Datetime
Delta delta Integer

Self-description

{
  "auth": true,
  "description": "List current IP 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
      },
      "ip_address": {
        "required": null,
        "label": "IpAddress",
        "description": null,
        "type": "Resource",
        "resource": [
          "ip_address"
        ],
        "value_id": "id",
        "value_label": "addr",
        "value": null,
        "choices": {
          "path": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "user": {
        "required": null,
        "label": "User",
        "description": null,
        "type": "Resource",
        "resource": [
          "user"
        ],
        "value_id": "id",
        "value_label": "login",
        "value": null,
        "choices": {
          "path": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?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
      },
      "environment": {
        "required": null,
        "label": "Environment",
        "description": null,
        "type": "Resource",
        "resource": [
          "environment"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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": "/v5.0/locations",
          "method": "GET",
          "help": "/v5.0/locations?method=GET"
        }
      },
      "network": {
        "required": null,
        "label": "Network",
        "description": null,
        "type": "Resource",
        "resource": [
          "network"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/networks",
          "method": "GET",
          "help": "/v5.0/networks?method=GET"
        }
      },
      "node": {
        "required": null,
        "label": "Node",
        "description": null,
        "type": "Resource",
        "resource": [
          "node"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/nodes",
          "method": "GET",
          "help": "/v5.0/nodes?method=GET"
        }
      },
      "vps": {
        "required": null,
        "label": "VPS",
        "description": null,
        "type": "Resource",
        "resource": [
          "vps"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/vpses",
          "method": "GET",
          "help": "/v5.0/vpses?method=GET"
        }
      },
      "order": {
        "required": false,
        "label": "Order",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": "-bytes",
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_traffic_monitor"
  },
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "user": {
        "required": null,
        "label": "User",
        "description": null,
        "type": "Resource",
        "resource": [
          "user"
        ],
        "value_id": "id",
        "value_label": "login",
        "value": null,
        "choices": {
          "path": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "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
      },
      "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
      },
      "public_packets": {
        "required": false,
        "label": "Public_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_packets_in": {
        "required": false,
        "label": "Public_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_packets_out": {
        "required": false,
        "label": "Public_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_bytes": {
        "required": false,
        "label": "Public_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_bytes_in": {
        "required": false,
        "label": "Public_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_bytes_out": {
        "required": false,
        "label": "Public_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_packets": {
        "required": false,
        "label": "Public_tcp_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_packets_in": {
        "required": false,
        "label": "Public_tcp_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_packets_out": {
        "required": false,
        "label": "Public_tcp_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_bytes": {
        "required": false,
        "label": "Public_tcp_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_bytes_in": {
        "required": false,
        "label": "Public_tcp_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_bytes_out": {
        "required": false,
        "label": "Public_tcp_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_packets": {
        "required": false,
        "label": "Public_udp_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_packets_in": {
        "required": false,
        "label": "Public_udp_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_packets_out": {
        "required": false,
        "label": "Public_udp_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_bytes": {
        "required": false,
        "label": "Public_udp_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_bytes_in": {
        "required": false,
        "label": "Public_udp_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_bytes_out": {
        "required": false,
        "label": "Public_udp_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_packets": {
        "required": false,
        "label": "Public_other_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_packets_in": {
        "required": false,
        "label": "Public_other_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_packets_out": {
        "required": false,
        "label": "Public_other_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_bytes": {
        "required": false,
        "label": "Public_other_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_bytes_in": {
        "required": false,
        "label": "Public_other_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_bytes_out": {
        "required": false,
        "label": "Public_other_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_packets": {
        "required": false,
        "label": "Private_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_packets_in": {
        "required": false,
        "label": "Private_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_packets_out": {
        "required": false,
        "label": "Private_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_bytes": {
        "required": false,
        "label": "Private_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_bytes_in": {
        "required": false,
        "label": "Private_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_bytes_out": {
        "required": false,
        "label": "Private_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_packets": {
        "required": false,
        "label": "Private_tcp_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_packets_in": {
        "required": false,
        "label": "Private_tcp_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_packets_out": {
        "required": false,
        "label": "Private_tcp_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_bytes": {
        "required": false,
        "label": "Private_tcp_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_bytes_in": {
        "required": false,
        "label": "Private_tcp_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_bytes_out": {
        "required": false,
        "label": "Private_tcp_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_packets": {
        "required": false,
        "label": "Private_udp_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_packets_in": {
        "required": false,
        "label": "Private_udp_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_packets_out": {
        "required": false,
        "label": "Private_udp_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_bytes": {
        "required": false,
        "label": "Private_udp_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_bytes_in": {
        "required": false,
        "label": "Private_udp_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_bytes_out": {
        "required": false,
        "label": "Private_udp_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_packets": {
        "required": false,
        "label": "Private_other_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_packets_in": {
        "required": false,
        "label": "Private_other_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_packets_out": {
        "required": false,
        "label": "Private_other_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_bytes": {
        "required": false,
        "label": "Private_other_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_bytes_in": {
        "required": false,
        "label": "Private_other_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_bytes_out": {
        "required": false,
        "label": "Private_other_bytes_out",
        "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
      },
      "delta": {
        "required": false,
        "label": "Delta",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "ip_traffic_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": [

  ],
  "path": "/v5.0/ip_traffic_monitors",
  "method": "GET",
  "help": "/v5.0/ip_traffic_monitors?method=GET"
}

Ip traffic monitor # Show

Path:
GET /v5.0/ip_traffic_monitors/{ip_traffic_monitor_id}
Description:
Show an IP traffic monitor
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
ip_traffic_monitor
Label Name Type Description
Id id Integer
IpAddress ip_address Resource
User user Resource
Packets packets Integer
Packets_in packets_in Integer
Packets_out packets_out Integer
Bytes bytes Integer
Bytes_in bytes_in Integer
Bytes_out bytes_out Integer
Public_packets public_packets Integer
Public_packets_in public_packets_in Integer
Public_packets_out public_packets_out Integer
Public_bytes public_bytes Integer
Public_bytes_in public_bytes_in Integer
Public_bytes_out public_bytes_out Integer
Public_tcp_packets public_tcp_packets Integer
Public_tcp_packets_in public_tcp_packets_in Integer
Public_tcp_packets_out public_tcp_packets_out Integer
Public_tcp_bytes public_tcp_bytes Integer
Public_tcp_bytes_in public_tcp_bytes_in Integer
Public_tcp_bytes_out public_tcp_bytes_out Integer
Public_udp_packets public_udp_packets Integer
Public_udp_packets_in public_udp_packets_in Integer
Public_udp_packets_out public_udp_packets_out Integer
Public_udp_bytes public_udp_bytes Integer
Public_udp_bytes_in public_udp_bytes_in Integer
Public_udp_bytes_out public_udp_bytes_out Integer
Public_other_packets public_other_packets Integer
Public_other_packets_in public_other_packets_in Integer
Public_other_packets_out public_other_packets_out Integer
Public_other_bytes public_other_bytes Integer
Public_other_bytes_in public_other_bytes_in Integer
Public_other_bytes_out public_other_bytes_out Integer
Private_packets private_packets Integer
Private_packets_in private_packets_in Integer
Private_packets_out private_packets_out Integer
Private_bytes private_bytes Integer
Private_bytes_in private_bytes_in Integer
Private_bytes_out private_bytes_out Integer
Private_tcp_packets private_tcp_packets Integer
Private_tcp_packets_in private_tcp_packets_in Integer
Private_tcp_packets_out private_tcp_packets_out Integer
Private_tcp_bytes private_tcp_bytes Integer
Private_tcp_bytes_in private_tcp_bytes_in Integer
Private_tcp_bytes_out private_tcp_bytes_out Integer
Private_udp_packets private_udp_packets Integer
Private_udp_packets_in private_udp_packets_in Integer
Private_udp_packets_out private_udp_packets_out Integer
Private_udp_bytes private_udp_bytes Integer
Private_udp_bytes_in private_udp_bytes_in Integer
Private_udp_bytes_out private_udp_bytes_out Integer
Private_other_packets private_other_packets Integer
Private_other_packets_in private_other_packets_in Integer
Private_other_packets_out private_other_packets_out Integer
Private_other_bytes private_other_bytes Integer
Private_other_bytes_in private_other_bytes_in Integer
Private_other_bytes_out private_other_bytes_out Integer
Updated_at updated_at Datetime
Delta delta Integer

Self-description

{
  "auth": true,
  "description": "Show an IP traffic monitor",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "ip_traffic_monitor"
  },
  "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": "/v5.0/ip_addresses",
          "method": "GET",
          "help": "/v5.0/ip_addresses?method=GET"
        }
      },
      "user": {
        "required": null,
        "label": "User",
        "description": null,
        "type": "Resource",
        "resource": [
          "user"
        ],
        "value_id": "id",
        "value_label": "login",
        "value": null,
        "choices": {
          "path": "/v5.0/users",
          "method": "GET",
          "help": "/v5.0/users?method=GET"
        }
      },
      "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
      },
      "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
      },
      "public_packets": {
        "required": false,
        "label": "Public_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_packets_in": {
        "required": false,
        "label": "Public_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_packets_out": {
        "required": false,
        "label": "Public_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_bytes": {
        "required": false,
        "label": "Public_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_bytes_in": {
        "required": false,
        "label": "Public_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_bytes_out": {
        "required": false,
        "label": "Public_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_packets": {
        "required": false,
        "label": "Public_tcp_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_packets_in": {
        "required": false,
        "label": "Public_tcp_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_packets_out": {
        "required": false,
        "label": "Public_tcp_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_bytes": {
        "required": false,
        "label": "Public_tcp_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_bytes_in": {
        "required": false,
        "label": "Public_tcp_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_tcp_bytes_out": {
        "required": false,
        "label": "Public_tcp_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_packets": {
        "required": false,
        "label": "Public_udp_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_packets_in": {
        "required": false,
        "label": "Public_udp_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_packets_out": {
        "required": false,
        "label": "Public_udp_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_bytes": {
        "required": false,
        "label": "Public_udp_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_bytes_in": {
        "required": false,
        "label": "Public_udp_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_udp_bytes_out": {
        "required": false,
        "label": "Public_udp_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_packets": {
        "required": false,
        "label": "Public_other_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_packets_in": {
        "required": false,
        "label": "Public_other_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_packets_out": {
        "required": false,
        "label": "Public_other_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_bytes": {
        "required": false,
        "label": "Public_other_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_bytes_in": {
        "required": false,
        "label": "Public_other_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "public_other_bytes_out": {
        "required": false,
        "label": "Public_other_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_packets": {
        "required": false,
        "label": "Private_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_packets_in": {
        "required": false,
        "label": "Private_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_packets_out": {
        "required": false,
        "label": "Private_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_bytes": {
        "required": false,
        "label": "Private_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_bytes_in": {
        "required": false,
        "label": "Private_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_bytes_out": {
        "required": false,
        "label": "Private_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_packets": {
        "required": false,
        "label": "Private_tcp_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_packets_in": {
        "required": false,
        "label": "Private_tcp_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_packets_out": {
        "required": false,
        "label": "Private_tcp_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_bytes": {
        "required": false,
        "label": "Private_tcp_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_bytes_in": {
        "required": false,
        "label": "Private_tcp_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_tcp_bytes_out": {
        "required": false,
        "label": "Private_tcp_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_packets": {
        "required": false,
        "label": "Private_udp_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_packets_in": {
        "required": false,
        "label": "Private_udp_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_packets_out": {
        "required": false,
        "label": "Private_udp_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_bytes": {
        "required": false,
        "label": "Private_udp_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_bytes_in": {
        "required": false,
        "label": "Private_udp_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_udp_bytes_out": {
        "required": false,
        "label": "Private_udp_bytes_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_packets": {
        "required": false,
        "label": "Private_other_packets",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_packets_in": {
        "required": false,
        "label": "Private_other_packets_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_packets_out": {
        "required": false,
        "label": "Private_other_packets_out",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_bytes": {
        "required": false,
        "label": "Private_other_bytes",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_bytes_in": {
        "required": false,
        "label": "Private_other_bytes_in",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "private_other_bytes_out": {
        "required": false,
        "label": "Private_other_bytes_out",
        "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
      },
      "delta": {
        "required": false,
        "label": "Delta",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "ip_traffic_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": [

  ],
  "path": "/v5.0/ip_traffic_monitors/{ip_traffic_monitor_id}",
  "method": "GET",
  "help": "/v5.0/ip_traffic_monitors/{ip_traffic_monitor_id}?method=GET"
}

Language


Available languages

Language # Index

Path:
GET /v5.0/languages
Description:
List languages
Authentication required:
no
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
language
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

Output parameters

Layout:
object_list
Namespace:
languages
Label Name Type Description
Id id Integer
Code code String
Label label String

Self-description

{
  "auth": false,
  "description": "List languages",
  "aliases": [
    "list"
  ],
  "blocking": false,
  "input": {
    "parameters": {
      "offset": {
        "required": false,
        "label": "Offset",
        "description": "The offset of the first object",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "limit": {
        "required": false,
        "label": "Limit",
        "description": "The number of objects to retrieve",
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "language"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "code": {
        "required": false,
        "label": "Code",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object_list",
    "namespace": "languages"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "count": {
            "required": false,
            "label": "Return the count of all items",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": false,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": {
        "parameters": {
          "total_count": {
            "required": false,
            "label": "Total count of all items",
            "description": null,
            "type": "Integer",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    }
  },
  "examples": [

  ],
  "path": "/v5.0/languages",
  "method": "GET",
  "help": "/v5.0/languages?method=GET"
}

Language # Show

Path:
GET /v5.0/languages/{language_id}
Description:
Show language
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
language
Label Name Type Description
Id id Integer
Code code String
Label label String

Self-description

{
  "auth": true,
  "description": "Show language",
  "aliases": [
    "find"
  ],
  "blocking": false,
  "input": {
    "parameters": {
    },
    "layout": "object",
    "namespace": "language"
  },
  "output": {
    "parameters": {
      "id": {
        "required": false,
        "label": "Id",
        "description": null,
        "type": "Integer",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "code": {
        "required": false,
        "label": "Code",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "label": {
        "required": false,
        "label": "Label",
        "description": null,
        "type": "String",
        "validators": {
        },
        "default": null,
        "protected": false
      }
    },
    "layout": "object",
    "namespace": "language"
  },
  "meta": {
    "object": {
      "input": null,
      "output": {
        "parameters": {
          "path_params": {
            "required": false,
            "label": "URL parameters",
            "description": "An array of parameters needed to resolve URL to this object",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "resolved": {
            "required": false,
            "label": "Resolved",
            "description": "True if the association is resolved",
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      }
    },
    "global": {
      "input": {
        "parameters": {
          "no": {
            "required": false,
            "label": "Disable metadata",
            "description": null,
            "type": "Boolean",
            "validators": {
            },
            "default": null,
            "protected": false
          },
          "includes": {
            "required": false,
            "label": "Included associations",
            "description": "A list of names of associated resources separated by a comma.\nNested associations are declared with '__' between resource names.\nFor example, 'user,node' will resolve the two associations.\nTo resolve further associations of node, use e.g. 'user,node__location',\nto go even deeper, use e.g. 'user,node__location__environment'.\n",
            "type": "Custom",
            "validators": {
            },
            "default": null,
            "protected": false
          }
        },
        "layout": "hash",
        "namespace": false
      },
      "output": null
    }
  },
  "examples": [

  ],
  "path": "/v5.0/languages/{language_id}",
  "method": "GET",
  "help": "/v5.0/languages/{language_id}?method=GET"
}

Location


Manage locations

Location # Create

Path:
POST /v5.0/locations
Description:
Create new location
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
location
Label Name Required Type Validators Default Description
Label label no String Location label
Has IPv6 has_ipv6 no Boolean
Include
values
[true, false]
message
%{value} cannot be used
True if location has IPv6 addresses
VPS onboot vps_onboot no Boolean Start all VPSes in this location on boot?
Remote console server remote_console_server no String
Format
rx
\A(https?://.+)?\Z
match
true
description
message
invalid format
URL to HTTP remote console server
Domain domain no String
Format
rx
[[0-9a-zA-Z\-\.]{3,255}]
match
true
description
message
invalid format
Location domain, subdomain at environment domain
Environment environment no Resource

Output parameters

Layout:
object
Namespace:
location
Label Name Type Description
ID id Integer Location ID
Label label String Location label
Has IPv6 has_ipv6 Boolean True if location has IPv6 addresses
VPS onboot vps_onboot Boolean Start all VPSes in this location on boot?
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

Self-description

{
  "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
      },
      "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
      },
      "vps_onboot": {
        "required": false,
        "label": "VPS onboot",
        "description": "Start all VPSes in this location on boot?",
        "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": {
          "format": {
            "rx": "\\A(https?://.+)?\\Z",
            "match": true,
            "description": null,
            "message": "invalid format"
          }
        },
        "default": null,
        "protected": false
      },
      "domain": {
        "required": false,
        "label": "Domain",
        "description": "Location domain, subdomain at environment domain",
        "type": "String",
        "validators": {
          "format": {
            "rx": "[[0-9a-zA-Z\\-\\.]{3,255}]",
            "match": true,
            "description": null,
            "message": "invalid format"
          }
        },
        "default": null,
        "protected": false
      },
      "environment": {
        "required": null,
        "label": "Environment",
        "description": null,
        "type": "Resource",
        "resource": [
          "environment"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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
      },
      "has_ipv6": {
        "required": false,
        "label": "Has IPv6",
        "description": "True if location has IPv6 addresses",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_onboot": {
        "required": false,
        "label": "VPS onboot",
        "description": "Start all VPSes in this location on boot?",
        "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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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,
        "vps_onboot": true,
        "remote_console_server": "",
        "domain": "brq"
      },
      "response": {
        "id": 2
      },
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/locations",
  "method": "POST",
  "help": "/v5.0/locations?method=POST"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.location.create({:label=>"Brno",
 :has_ipv6=>true,
 :vps_onboot=>true,
 :remote_console_server=>"",
 :domain=>"brq"})

# reply is an instance of HaveAPI::Client::ResourceInstance
# reply.id = 2
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});

api.location.create({
  "label": "Brno",
  "has_ipv6": true,
  "vps_onboot": true,
  "remote_console_server": "",
  "domain": "brq"
}, function (client, reply) {
  console.log('Response', reply);
  // reply is an instance of HaveAPI.Client.ResourceInstance
  // reply.id = 2
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->location->create([
  "label" => "Brno",
  "has_ipv6" => true,
  "vps_onboot" => true,
  "remote_console_server" => "",
  "domain" => "brq"
]);

// $reply is an instance of \HaveAPI\Client\ResourceInstance
// $reply->id = 2
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 location create -- \
              --label 'Brno' \
              --has-ipv6 \
              --vps-onboot \
              --remote-console-server '' \
              --domain 'brq'
                    ID:  2
                 Label:  -
              Has IPv6:  -
            VPS onboot:  -
 Remote console server:  -
                Domain:  -
           Environment:  -

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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 'true' > input/vps_onboot
$ 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
$ curl --request POST \
       --data-binary "{
  \"location\": {
    \"label\": \"Brno\",
    \"has_ipv6\": true,
    \"vps_onboot\": true,
    \"remote_console_server\": \"\",
    \"domain\": \"brq\"
  }
}" \
       'http://api.vpsfree.cz/v5.0/locations'
Response
{
  "status": true,
  "message": null,
  "response": {
    "location": {
      "id": 2
    }
  },
  "errors": null
}
HTTP
Request
POST /v5.0/locations HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

{
  "location": {
    "label": "Brno",
    "has_ipv6": true,
    "vps_onboot": true,
    "remote_console_server": "",
    "domain": "brq"
  }
}
Response
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
}

Location # Index

Path:
GET /v5.0/locations
Description:
List locations
Authentication required:
no
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
location
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

Output parameters

Layout:
object_list
Namespace:
locations
Label Name Type Description
ID id Integer Location ID
Label label String Location label
Has IPv6 has_ipv6 Boolean True if location has IPv6 addresses
VPS onboot vps_onboot Boolean Start all VPSes in this location on boot?
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

Self-description

{
  "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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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
      }
    },
    "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
      },
      "has_ipv6": {
        "required": false,
        "label": "Has IPv6",
        "description": "True if location has IPv6 addresses",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_onboot": {
        "required": false,
        "label": "VPS onboot",
        "description": "Start all VPSes in this location on boot?",
        "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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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,
          "vps_onboot": true,
          "remote_console_server": "https://console.vpsadmin.mydomain.com",
          "domain": "prg"
        }
      ],
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/locations",
  "method": "GET",
  "help": "/v5.0/locations?method=GET"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.location.index

# reply is an instance of HaveAPI::Client::ResourceInstanceList,
# which is a subclass of Array
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});

api.location.index(function (client, reply) {
  console.log('Response', reply);
  // reply is an instance of HaveAPI.Client.ResourceInstanceList
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->location->index();

// $reply is an instance of \HaveAPI\Client\ResourceInstanceList
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 location index
                    ID:  -
                 Label:  Prague
              Has IPv6:  true
            VPS onboot:  true
 Remote console server:  https://console.vpsadmin.mydomain.com
                Domain:  prg
           Environment:  -
      Maintenance lock:  -
    Maintenance reason:  -

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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
$ curl --request GET \
       --data-binary "{
  \"location\": {
  }
}" \
       'http://api.vpsfree.cz/v5.0/locations'
Response
{
  "status": true,
  "message": null,
  "response": {
    "locations": [
      {
        "label": "Prague",
        "has_ipv6": true,
        "vps_onboot": true,
        "remote_console_server": "https://console.vpsadmin.mydomain.com",
        "domain": "prg"
      }
    ]
  },
  "errors": null
}
HTTP
Request
GET /v5.0/locations HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 298

{
  "status": true,
  "message": null,
  "response": {
    "locations": [
      {
        "label": "Prague",
        "has_ipv6": true,
        "vps_onboot": true,
        "remote_console_server": "https://console.vpsadmin.mydomain.com",
        "domain": "prg"
      }
    ]
  },
  "errors": null
}

Location # Set_maintenance

Path:
POST /v5.0/locations/{location_id}/set_maintenance
Description:
Set maintenance lock
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
hash
Namespace:
location
Label Name Required Type Validators Default Description
Lock lock yes Boolean
Present
empty
false
message
must be present and non-empty
Reason reason no String

Output parameters

No parameters.

Self-description

{
  "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": [

  ],
  "path": "/v5.0/locations/{location_id}/set_maintenance",
  "method": "POST",
  "help": "/v5.0/locations/{location_id}/set_maintenance?method=POST"
}

Location # Show

Path:
GET /v5.0/locations/{location_id}
Description:
Show location
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
location
Label Name Type Description
ID id Integer Location ID
Label label String Location label
Has IPv6 has_ipv6 Boolean True if location has IPv6 addresses
VPS onboot vps_onboot Boolean Start all VPSes in this location on boot?
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

Self-description

{
  "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
      },
      "has_ipv6": {
        "required": false,
        "label": "Has IPv6",
        "description": "True if location has IPv6 addresses",
        "type": "Boolean",
        "validators": {
        },
        "default": null,
        "protected": false
      },
      "vps_onboot": {
        "required": false,
        "label": "VPS onboot",
        "description": "Start all VPSes in this location on boot?",
        "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": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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,
        "vps_onboot": true,
        "remote_console_server": "",
        "domain": "brq"
      },
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/locations/{location_id}",
  "method": "GET",
  "help": "/v5.0/locations/{location_id}?method=GET"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.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.vps_onboot = true
# reply.remote_console_server = ""
# reply.domain = "brq"
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.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.vps_onboot = true
  // reply.remote_console_server = ""
  // reply.domain = "brq"
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.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->vps_onboot = true
// $reply->remote_console_server = ""
// $reply->domain = "brq"
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 location show 2
                    ID:  2
                 Label:  Brno
              Has IPv6:  true
            VPS onboot:  true
 Remote console server:  -
                Domain:  brq
           Environment:  -
      Maintenance lock:  -
    Maintenance reason:  -

File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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/vps_onboot
1


$ cat output/remote_console_server



$ cat output/domain
brq

curl
Request
$ curl --request GET \
       --data-binary "{
  \"location\": {
  }
}" \
       'http://api.vpsfree.cz/v5.0/locations/2'
Response
{
  "status": true,
  "message": null,
  "response": {
    "location": {
      "id": 2,
      "label": "Brno",
      "has_ipv6": true,
      "vps_onboot": true,
      "remote_console_server": "",
      "domain": "brq"
    }
  },
  "errors": null
}
HTTP
Request
GET /v5.0/locations/2 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 247

{
  "status": true,
  "message": null,
  "response": {
    "location": {
      "id": 2,
      "label": "Brno",
      "has_ipv6": true,
      "vps_onboot": true,
      "remote_console_server": "",
      "domain": "brq"
    }
  },
  "errors": null
}

Location # Update

Path:
PUT /v5.0/locations/{location_id}
Description:
Update location
Authentication required:
yes
Aliases:
Blocking:
no

Input parameters

Layout:
object
Namespace:
location
Label Name Required Type Validators Default Description
Label label no String Location label
Has IPv6 has_ipv6 no Boolean
Include
values
[true, false]
message
%{value} cannot be used
True if location has IPv6 addresses
VPS onboot vps_onboot no Boolean Start all VPSes in this location on boot?
Remote console server remote_console_server no String
Format
rx
\A(https?://.+)?\Z
match
true
description
message
invalid format
URL to HTTP remote console server
Domain domain no String
Format
rx
[[0-9a-zA-Z\-\.]{3,255}]
match
true
description
message
invalid format
Location domain, subdomain at environment domain
Environment environment no Resource

Output parameters

No parameters.

Self-description

{
  "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
      },
      "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
      },
      "vps_onboot": {
        "required": false,
        "label": "VPS onboot",
        "description": "Start all VPSes in this location on boot?",
        "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": {
          "format": {
            "rx": "\\A(https?://.+)?\\Z",
            "match": true,
            "description": null,
            "message": "invalid format"
          }
        },
        "default": null,
        "protected": false
      },
      "domain": {
        "required": false,
        "label": "Domain",
        "description": "Location domain, subdomain at environment domain",
        "type": "String",
        "validators": {
          "format": {
            "rx": "[[0-9a-zA-Z\\-\\.]{3,255}]",
            "match": true,
            "description": null,
            "message": "invalid format"
          }
        },
        "default": null,
        "protected": false
      },
      "environment": {
        "required": null,
        "label": "Environment",
        "description": null,
        "type": "Resource",
        "resource": [
          "environment"
        ],
        "value_id": "id",
        "value_label": "label",
        "value": null,
        "choices": {
          "path": "/v5.0/environments",
          "method": "GET",
          "help": "/v5.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,
        "vps_onboot": true,
        "remote_console_server": "",
        "domain": "ova",
        "environment": 1
      },
      "response": {
      },
      "status": true,
      "message": null,
      "errors": null,
      "http_status": 200
    }
  ],
  "path": "/v5.0/locations/{location_id}",
  "method": "PUT",
  "help": "/v5.0/locations/{location_id}?method=PUT"
}

Examples

Example #0

Ruby
require 'haveapi-client'

client = HaveAPI::Client.new("http://api.vpsfree.cz", version: "5.0")

reply = client.location.update(2, {:label=>"Ostrava",
 :has_ipv6=>true,
 :vps_onboot=>true,
 :remote_console_server=>"",
 :domain=>"ova",
 :environment=>1})

# reply is an instance of HaveAPI::Client::ResourceInstance
JavaScript
import HaveAPI from 'haveapi-client'

var api = new HaveAPI.Client("http://api.vpsfree.cz", {version: "5.0"});

api.location.update(2, {
  "label": "Ostrava",
  "has_ipv6": true,
  "vps_onboot": true,
  "remote_console_server": "",
  "domain": "ova",
  "environment": 1
}, function (client, reply) {
  console.log('Response', reply);
  // reply is an instance of HaveAPI.Client.ResourceInstance
});
PHP
$api = new \HaveAPI\Client("http://api.vpsfree.cz", "5.0");

$reply = $api->location->update(2, [
  "label" => "Ostrava",
  "has_ipv6" => true,
  "vps_onboot" => true,
  "remote_console_server" => "",
  "domain" => "ova",
  "environment" => 1
]);

// $reply is an instance of \HaveAPI\Client\ResourceInstance
CLI
$ haveapi-cli -u http://api.vpsfree.cz --version 5.0 location update 2 -- \
              --label 'Ostrava' \
              --has-ipv6 \
              --vps-onboot \
              --remote-console-server '' \
              --domain 'ova' \
              --environment '1'
File system
# Mount the file system
$ haveapi-fs http://api.vpsfree.cz /mnt/api.vpsfree.cz -o version=5.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 'true' > input/vps_onboot
$ 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
$ curl --request PUT \
       --data-binary "{
  \"location\": {
    \"label\": \"Ostrava\",
    \"has_ipv6\": true,
    \"vps_onboot\": true,
    \"remote_console_server\": \"\",
    \"domain\": \"ova\",
    \"environment\": 1
  }
}" \
       'http://api.vpsfree.cz/v5.0/locations/2'
Response
{
  "status": true,
  "message": null,
  "response": {
    "location": {
    }
  },
  "errors": null
}
HTTP
Request
PUT /v5.0/locations/2 HTTP/1.1
Host: api.vpsfree.cz
Content-Type: application/json

{
  "location": {
    "label": "Ostrava",
    "has_ipv6": true,
    "vps_onboot": true,
    "remote_console_server": "",
    "domain": "ova",
    "environment": 1
  }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 102

{
  "status": true,
  "message": null,
  "response": {
    "location": {
    }
  },
  "errors": null
}

Mail log


Browse sent mails

Mail log # Index

Path:
GET /v5.0/mail_logs
Description:
List mails
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
mail_log
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

Output parameters

Layout:
object_list
Namespace:
mail_logs
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

Self-description

{
  "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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/mail_templates",
          "method": "GET",
          "help": "/v5.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": [

  ],
  "path": "/v5.0/mail_logs",
  "method": "GET",
  "help": "/v5.0/mail_logs?method=GET"
}

Mail log # Show

Path:
GET /v5.0/mail_logs/{mail_log_id}
Description:
View mail
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
mail_log
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

Self-description

{
  "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": "/v5.0/users",
          "method": "GET",
          "help": "/v5.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": "/v5.0/mail_templates",
          "method": "GET",
          "help": "/v5.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": [

  ],
  "path": "/v5.0/mail_logs/{mail_log_id}",
  "method": "GET",
  "help": "/v5.0/mail_logs/{mail_log_id}?method=GET"
}

Mail recipient


Manage mail recipients

Mail recipient # Create

Path:
POST /v5.0/mail_recipients
Description:
Create a mail recipient
Authentication required:
yes
Aliases:
new
Blocking:
no

Input parameters

Layout:
object
Namespace:
mail_recipient
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

Output parameters

Layout:
object
Namespace:
mail_recipient
Label Name Type Description
Id id Integer
Label label String Human-friendly label
To to String
Cc cc String
Bcc bcc String

Self-description

{
  "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": [

  ],
  "path": "/v5.0/mail_recipients",
  "method": "POST",
  "help": "/v5.0/mail_recipients?method=POST"
}

Mail recipient # Delete

Path:
DELETE /v5.0/mail_recipients/{mail_recipient_id}
Description:
Delete a mail recipient
Authentication required:
yes
Aliases:
destroy
Blocking:
no

Input parameters

No parameters.

Output parameters

No parameters.

Self-description

{
  "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": [

  ],
  "path": "/v5.0/mail_recipients/{mail_recipient_id}",
  "method": "DELETE",
  "help": "/v5.0/mail_recipients/{mail_recipient_id}?method=DELETE"
}

Mail recipient # Index

Path:
GET /v5.0/mail_recipients
Description:
List mail recipients
Authentication required:
yes
Aliases:
list
Blocking:
no

Input parameters

Layout:
object
Namespace:
mail_recipient
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

Output parameters

Layout:
object_list
Namespace:
mail_recipients
Label Name Type Description
Id id Integer
Label label String Human-friendly label
To to String
Cc cc String
Bcc bcc String

Self-description

{
  "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": [

  ],
  "path": "/v5.0/mail_recipients",
  "method": "GET",
  "help": "/v5.0/mail_recipients?method=GET"
}

Mail recipient # Show

Path:
GET /v5.0/mail_recipients/{mail_recipient_id}
Description:
View mail recipient
Authentication required:
yes
Aliases:
find
Blocking:
no

Input parameters

No parameters.

Output parameters

Layout:
object
Namespace:
mail_recipient
Label Name Type Description