Sha256: 64b7b300fce71a0b1f14efccdbb8ed6e7b3f4ed9e6f8e3ad2c056b2ef8e6d7dc
Contents?: true
Size: 1.71 KB
Versions: 31
Compression:
Stored size: 1.71 KB
Contents
# Instances Actions Details on the various actions that can be performed on the Instances resource, including the expected parameters and the potential responses. ##### Contents * [Get](#get) <br/> ## Get Returns a collection of instances ```ruby result = client.instances.get(optional_params) puts result ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.User, all.User.read, instances.*, or instances.get. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name | | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc | | page | string | N | Which page of results to return | 0 | 0 | | perPage | string | N | How many items to return per page | 100 | 10 | | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name | | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * instance | | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | #### Successful Responses | Code | Type | Description | | ---- | ---- | ----------- | | 200 | [Instances](_schemas.md#instances) | Collection of instances | #### Error Responses | Code | Type | Description | | ---- | ---- | ----------- | | 400 | [Error](_schemas.md#error) | Error if malformed request |
Version data entries
31 entries across 31 versions & 1 rubygems