Constructor

The Ably REST library constructor is overloaded allowing it to be instantiated using a ClientOptions object, or more simply using a string containing an API key or Token.

new Ably.Rest(String keyOrTokenId)

This will instantiate the REST library with the provided API key or Token ID string.

new Ably.Rest(ClientOptions clientOptions)

The REST constructor is used to instantiate the library. The REST library may be instantiated multiple times with the same or different ClientOptions in any given context. Except where specified otherwise, instances operate independently of one another.

The REST library needs to have credentials to be able to authenticate with the Ably service. Ably supports both Basic and Token based authentication schemes. Read more on authentication.

Basic Authentication

A private API key string for ClientOptions#key or the constructor, as obtained from the application dashboard, is required for Basic Authentication. Use this option if you wish to use Basic authentication, or if you want to be able to request Ably Tokens without needing to defer to a separate entity to sign Ably TokenRequests. Note that initializing the library with a key does not necessarily mean that the library will use Basic auth; using the private key it is also able to create and sign Ably TokenRequests and use token authentication when necessary.

Token Authentication

The ClientOptions#token option takes a token string, and assumes that the Ably-compatible token has been obtained from some other instance that requested the token. Use the token option if you are provided with a token to use and you do not have a key (or do not have a key with the capabilities that you require).

Since tokens are short-lived, it is rarely sufficient to start with a token without the means for refreshing it. The authUrl and authCallback options are provided to allow a user of the library to provide new Ably-compatible tokens or Ably TokenRequests to the library as required; using these options allows the library to be instantiated without a key or token, and an initial token will be obtained automatically when required.

Read more on authentication.

The REST client exposes the following public properties:

A reference to the Auth authentication object configured for this client library.

A reference to the Push object in this client library.

Channels is a reference to the Channel collection instance for this library indexed by the channel name. You can use the Get method of this to get a Channel instance. See channels and messages for more information.

stats(Object params?): Promise<PaginatedResult<Stats>>

This call queries the REST /stats API and retrieves your application’s usage statistics. A PaginatedResult is returned, containing an array of Stats for the first page of results. PaginatedResult objects are iterable providing a means to page through historical statistics. See an example set of raw stats returned via the REST API.

See statistics for more information.

Parameters

params

an optional object set of parameters used to specify which statistics are retrieved. If not specified the default parameters will be used

params properties

The following options, as defined in the REST /stats API endpoint, are permitted:

start

beginning of time earliest time in milliseconds since the epoch for any stats retrievedType: Number

end

current time latest time in milliseconds since the epoch for any stats retrievedType: Number

direction

backwards forwards or backwardsType: String

limit

100 maximum number of stats to retrieve up to 1,000Type: Number

unit

minute minute, hour, day or month. Based on the unit selected, the given start or end times are rounded down to the start of the relevant interval depending on the unit granularity of the queryType: StatsIntervalGranularity

time(): Promise<Number>

Obtains the time from the Ably service as milliseconds since epoch. (Clients that do not have access to a sufficiently well maintained time source and wish to issue Ably TokenRequests with a more accurate timestamp should use the queryTime clientOptions instead of this method).

request(method, path, version, params?, body?, headers?): Promise<HttpPaginatedResponse>

Makes a REST request to a provided path. This is provided as a convenience for developers who wish to use REST API functionality that is either not documented or is not yet included in the public API, without having to handle authentication, paging, fallback hosts, MsgPack and JSON support, etc. themselves.

Parameters

method

either get, post, put, patch or delete.Type: String

path

the path to query.Type: String

version

version of the REST API to use.Type: Number

params

(optional) any querystring parameters needed.Type: Object

body

(optional; for post, put and patch methods) the body of the request, as anything that can be serialized into JSON, such as an Object or Array.Type: Serializable

headers

(optional) any headers needed. If provided, these will be mixed in with the default library headers.Type: Object

Example

JavaScriptNode.js
JavaScript v2.11

const response = await rest.request(
  'get',
  '/channels/someChannel/messages',
  3,
  { limit: 1, direction: 'forwards' },
);
console.log('Success! status code was ' + response.statusCode);
console.log(response.items.length + ' items returned');
if (response.hasNext()) {
  const nextPage = await response.next();
  console.log(nextPage.items.length + ' more items returned');
}

Copy
Copied!

Properties

key

The full key string, as obtained from the application dashboard. Use this option if you wish to use Basic authentication, or wish to be able to issue Ably Tokens without needing to defer to a separate entity to sign Ably TokenRequests. Read more about Basic authenticationType: String

token

An authenticated token. This can either be a TokenDetails object, a TokenRequest object, or token string (obtained from the token property of a TokenDetails component of an Ably TokenRequest response, or a JSON Web Token satisfying the Ably requirements for JWTs). This option is mostly useful for testing: since tokens are short-lived, in production you almost always want to use an authentication method that allows the client library to renew the token automatically when the previous one expires, such as authUrl or authCallback. Read more about Token authenticationType: String, TokenDetails or TokenRequest

authCallback

A function with the form function(tokenParams, callback(err, tokenOrTokenRequest)) which is called when a new token is required. The role of the callback is to obtain a fresh token, one of: an Ably Token string (in plain text format); a signed TokenRequest ; a TokenDetails (in JSON format); an Ably JWT. See our authentication documentation for details of the Ably TokenRequest format and associated API calls.Type: Callable

authUrl

A URL that the library may use to obtain a fresh token, one of: an Ably Token string (in plain text format); a signed TokenRequest ; a TokenDetails (in JSON format); an Ably JWT. For example, this can be used by a client to obtain signed Ably TokenRequests from an application server.Type: String

authMethod

GET The HTTP verb to use for the request, either GET or POSTType: String

authHeaders

A set of key value pair headers to be added to any request made to the authUrl. Useful when an application requires these to be added to validate the request or implement the response. If the authHeaders object contains an authorization key, then withCredentials will be set on the xhr request.Type: Object

authParams

A set of key value pair params to be added to any request made to the authUrl. When the authMethod is GET, query params are added to the URL, whereas when authMethod is POST, the params are sent as URL encoded form data. Useful when an application require these to be added to validate the request or implement the response.Type: Object

tokenDetails

An authenticated TokenDetails object (most commonly obtained from an Ably Token Request response). This option is mostly useful for testing: since tokens are short-lived, in production you almost always want to use an authentication method that allows the client library to renew the token automatically when the previous one expires, such as authUrl or authCallback. Use this option if you wish to use Token authentication. Read more about Token authenticationType: TokenDetails

tls

true A boolean value, indicating whether or not a TLS (“SSL“) secure connection should be used. An insecure connection cannot be used with Basic authentication as it would lead to a possible compromise of the private API key while in transit. Find out more about TLSType: Boolean

clientId

A client ID, used for identifying this client when publishing messages or for presence purposes. The clientId can be any non-empty string. This option is primarily intended to be used in situations where the library is instantiated with a key; note that a clientId may also be implicit in a token used to instantiate the library; an error will be raised if a clientId specified here conflicts with the clientId implicit in the token. Find out more about client identitiesType: String

useTokenAuth

false When true, forces Token authentication to be used by the library. Please note that if a clientId is not specified in the ClientOptions or TokenParams, then the Ably Token issued will be anonymous. Type: Boolean

endpoint

null Enables enterprise customers to use their own custom endpoints, which support dedicated, isolated clusters and regional message routing and storage constraints. See our platform customization guide for more details.Type: String

environment

null Deprecated, use endpoint. Enables enterprise customers to use their own custom environments, which support dedicated, isolated clusters and regional message routing and storage constraints. See our platform customization guide for more details.Type: String

idempotentRestPublishing

false When true, enables idempotent publishing by assigning a unique message ID client-side, allowing the Ably servers to discard automatic publish retries following a failure such as a network fault. We recommend you enable this by default. In version 1.2 onwards, idempotent publishing for retries will be enabled by default.Type: Boolean

fallbackHosts

[a.ably-realtime.com, b.ably-realtime.com, c.ably-realtime.com, d.ably-realtime.com, e.ably-realtime.com] An array of fallback hosts to be used in the case of an error necessitating the use of an alternative host. When a custom environment is specified, the fallback host functionality is disabled. If your customer success manager has provided you with a set of custom fallback hosts, please specify them here.Type: String []

transportParams

Optional. Can be used to pass in arbitrary connection parameters, such as heartbeatInterval and remainPresentForType: Object

useBinaryProtocol

false If set to true, will enable the binary protocol (MessagePack) if it is supported. It’s disabled by default on browsers for performance considerations (browsers are optimized for decoding JSON). Find out more about the benefits of binary encodingType: Boolean

queryTime

false If true, the library will query the Ably servers for the current time when issuing TokenRequests instead of relying on a locally-available time of day. Knowing the time accurately is needed to create valid signed Ably TokenRequests, so this option is useful for library instances on auth servers where for some reason the server clock cannot be kept synchronized through normal means, such as an NTP daemon . The server is queried for the current time once per client library instance (which stores the offset from the local clock), so if using this option you should avoid instancing a new version of the library for each request.Type: Boolean

defaultTokenParams

When a TokenParams object is provided, it will override the client library defaults when issuing new Ably Tokens or Ably TokenRequestsType: TokenParams

A Stats object represents an application’s statistics for the specified interval and time period. Ably aggregates statistics globally for all accounts and applications, and makes these available both through our statistics API as well as your application dashboard.

Properties

JavaScript
JavaScript v2.11

const StatsIntervalGranularity = [
    'minute',
    'hour',
    'day',
    'month'
]

Copy
Copied!

An HttpPaginatedResponse is a superset of PaginatedResult, which is a type that represents a page of results plus metadata indicating the relative queries available to it. HttpPaginatedResponse additionally carries information about the response to an HTTP request. It is used when making custom HTTP requests.

Properties

statusCode

the HTTP status code of the responseType: Number

success

whether the HTTP status code indicates success. This is equivalent to 200 <= statusCode < 300Type: Boolean

headers

the headers of the responseType: Object

errorCode

the error code if the X-Ably-Errorcode HTTP header is sent in the responseType: Number

errorMessage

the error message if the X-Ably-Errormessage HTTP header is sent in the responseType: String

Methods

first(): Promise<HttpPaginatedResponse>

Boolean hasNext()

Returns true if there are more pages available by calling next and returns false if this page is the last page available.

Boolean isLast()

Returns true if this page is the last page and returns false if there are more pages available by calling next available.

next(): Promise<HttpPaginatedResponse>

Example

The HttpPaginatedResponse interface is a superset of PaginatedResult, see the PaginatedResult example