Get a list of the Data Orchestrators that are registered with DSCC

get/backup-recovery/v1beta1/data-orchestrators

This API returns a list of all the Data Orchestrators that are registered with the DSCC customer account.

Securitybearer
Request
query Parameters
offset
integer

When listing a large number of Data Orchestrators, the offset query parameter defines the index of the first Data Orchestrator to include in the response.

Example:

  • GET /backup-recovery/v1beta1/data-orchestrators?offset=10
limit
integer [ 1 .. 1000 ]
Default: 20

The limit query parameter defines the maximum number of Data Orchestrators to included in the response.

Example:

  • GET /backup-recovery/v1beta1/data-orchestrators?limit=10
sort
string

The sort query is a comma separated list of properties defining the sort order. The direction indicator may only be either “asc” (ascending) or “desc” (descending). If no direction indicator is specified, the default order is ascending.

Sorting is supported on the following properties:

  • name
  • generation
  • connectionState
  • serialNumber
  • softwareVersion
  • status
  • state
  • stateReason
  • id
  • platform
  • vCpu
  • totalMemoryInGiB
  • poweredOnAt
  • createdAt
  • interfaces/network/defaultGateway
  • dateTime/methodDateTimeSet
  • dateTime/timezone
  • ntp/status
  • ntp/state
  • ntp/stateReason

Example:

  • GET /backup-recovery/v1beta1/data-orchestrators?sort=name,generation desc
select
string

The select query parameter is used to define a subset of properties to be included in the response. Each property to be included should be passed in a comma-separated list.

Example:

  • GET /backup-recovery/v1beta1/data-orchestrators?select=id,name,serialNumber
filter
string

The filter query parameter is used to filter the list of on-prem engines returned in the response. The returned set of resources will match the criteria in the filter query parameter.

A comparision compares a property name to a literal. The comparisons supported are the following:

  • “eq” : Is a property equal to value. Valid for number, boolean and string properties.
  • “gt” : Is a property greater than a value. Valid for number or string timestamp properties.
  • “lt” : Is a property less than a value. Valid for number or string timestamp properties
  • “in” : Is a value in a property (that is an array of strings)

Examples:

  • GET /backup-recovery/v1beta1/data-orchestrators?filter=connectionState eq 'CONNECTED'
  • GET /backup-recovery/v1beta1/data-orchestrators?filter=connectionState eq 'CONNECTED' and status eq 'ERROR'

Filtering is supported with the following attributes:

  • id
  • name
  • interfaces/network/hostname
  • serialNumber
  • status
  • state
  • connectionState
  • softwareVersion
Responses
200

List of Data Orchestrators registered with DSCC

400

Bad/Malformed request

401

Unauthorized request

403

Forbidden

404

The filter attribute's value does not exist

500

Internal server error

503

Service not available

Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "offset": 0,
  • "total": 0
}