Sign in

Returns a list of instances of the given ROFL app.

Changed on
get/{runtime}/rofl_apps/{id}/instances

Request

  • Base URL: https://nexus.oasis.io/v1
  • URL: https://nexus.oasis.io/v1/{runtime}/rofl_apps/{id}/instances
  • Auth: none declared

Path parameters

runtime'emerald' | 'sapphire' | 'pontusxtest' | 'pontusxdev' | 'cipher' required
Example:sapphire

The runtime which to query.

idstring required

The ID of the ROFL app to return instances for.

Query parameters

limitinteger

The maximum numbers of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

Response

A JSON object containing a list of ROFL app instances.

total_countinteger required

The total number of records that match the query, i.e. the number of records the query would return with limit=infinity.

is_total_count_clippedboolean required

Whether total_count is clipped for performance reasons.

Example response

{
  "total_count": 412,
  "is_total_count_clipped": true
}

Changes

  • v153eeb16bfff2Revision changes
    • info

      added the optional property /////// to the response with the status

  • v19d302aadedb6Revision changes
    • warning

      removed the optional property /////// from the response with the status