<<

NAME

Location - Monitoring locations.

FORMAL SPECIFICATION

WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/Location.wsdl

JSON: https://api.cloudmonit.pl/2.0.0/json/Location.json

DESCRIPTION

This module can be used to obtain information about available monitoring locations (also called sensors or monitoring stations).

METHODS

Find

This method allows you to fetch information about selected Location objects.

Arguments

• filters - optional

  Filters to apply to the results.

  An array of objects, each containg the fields:

  • argument (string)

    The filter argument (the text to be contained in the field, or value to be compared). The argument must be of the same type as the field you filter by.

  • field (string)

    The field to filter the results by.

    Allowed values are: city, color, country, group_id, id, ip, is_available, link, name.

  • type (string)

    The type of filter. Filters (not_)greater_than and (not_)lower_than compare numbers numerically and string lexicographically. Defaults to "equals".

    Allowed values are: contains, equals, greater_than, lower_than, not_greater_than, not_lower_than.

  Maximum array length: 10.

• limit (unsigned integer or NULL) - optional

  Items per page. If not specified, NULL or 0, all elements will be fetched. You should probably specify results ordering as well, if you want the results to be consistent.

• offset (unsigned integer) - optional

  The index of the first element to show on page. Items are numbered starting from 0. Default is 0. Only meaningful if limit is specified as well.

• order - optional

  Fields to order the results by, starting from the most significant.

  An array of objects, each containg the fields:

  • direction (string) - optional

    The ordering direction, "ascending" or "descending".

    Allowed values are: ascending, descending.

    Defaults to "ascending" if not specified.

  • field (string)

    The field to order by. If not specified, the results can be returned in any order.

    Allowed values are: city, color, country, id, ip, is_available, link, name.

  Maximum array length: 10.

• with - optional

  The groups of fields to be returned with each object.

  An array of strings.

  No values are supported at the moment.

  This array cannot contain duplicate values.

  Defaults to [] if not specified.

Returns

• elements

  An array of objects, each containg the fields:

  • city (string)

    The city that the sensor is located in.

  • color (string)

    The location's color, given as 6 letters of hexadecimal RGB. This is the color used on the service response time in the Administration Panel.

    This value must match the /^[0-9a-f]{6}$/ regular expression.

  • country (string)

    The country that the sensor is located in.

  • id (unsigned integer)

    The location's identifier.

  • ip (string)

    The IPv4 address of the location.

  • is_available (boolean)

    Whether the location is available to set.

  • link (string)

    The network links available in the location.

  • name (string)

    The name of the location.

• total (unsigned integer)

  The total number of results (not including pagination).

Authorization

This method can be called by read-only users.

Meta

Returns the JSON or WSDL specification of the Location API module.

WARNING

This method is meant for internal usage in API clients. Unless you are writing one, you probably do not need it.

Arguments

• format (string) - optional

  The specification format you want to use. If omitted, defaults to json if you call this method using JSON request ot wsdl if you call this method with SOAP.

  Allowed values are: json, wsdl.

Returns

• encoded_meta (string)

  The specification of the module.

• format (string)

  The specification format used.

  Allowed values are: json, wsdl.

Authorization

This method can be called by read-only users.

Read

This method allows you to get information about a single Location object.

Arguments

• id (unsigned integer)

  The location's identifier.

• with - optional

  The groups of fields to be returned with the object.

  An array of strings.

  No values are supported at the moment.

  This array cannot contain duplicate values.

  Defaults to [] if not specified.

Returns

• city (string)

  The city that the sensor is located in.

• color (string)

  The location's color, given as 6 letters of hexadecimal RGB. This is the color used on the service response time in the Administration Panel.

  This value must match the /^[0-9a-f]{6}$/ regular expression.

• country (string)

  The country that the sensor is located in.

• id (unsigned integer)

  The location's identifier.

• ip (string)

  The IPv4 address of the location.

• is_available (boolean)

  Whether the location is available to set.

• link (string)

  The network links available in the location.

• name (string)

  The name of the location.

Authorization

This method can be called by read-only users.

<<