Skip to main content
API docs by Redocly

public/portworx/pds/catalog/dataservices/apiv1/dataservices.proto (version not set)

Download OpenAPI specification:Download

DataServicesService

ListDataServices API lists the the data service resources.

query Parameters
enabled
string
Default: "ENABLED_UNSPECIFIED"
Enum: "ENABLED_UNSPECIFIED" "TRUE" "FALSE"

Filter data services based on enabled flag.

  • ENABLED_UNSPECIFIED: List all data services.
  • TRUE: List only enabled data services.
  • FALSE: List only disabled data services.
sort.sortBy
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "NAME" "CREATED_AT" "UPDATED_AT" "PHASE"

Name of the attribute to sort results by.

  • FIELD_UNSPECIFIED: Unspecified, do not use.
  • NAME: Sorting based on the name of the resource.
  • CREATED_AT: Sorting on create time of the resource.
  • UPDATED_AT: Sorting on update time of the resource.
  • PHASE: Sorting on phase of the resource.
sort.sortOrder
string
Default: "VALUE_UNSPECIFIED"
Enum: "VALUE_UNSPECIFIED" "ASC" "DESC"

Order of sorting to be applied on requested list. If sort_by having some value and sort_order is not provided, by default ascending order will be used to sort the list.

  • VALUE_UNSPECIFIED: Unspecified, do not use.
  • ASC: Sort order ascending.
  • DESC: Sort order descending.
pagination.pageNumber
string <int64>

Page number is the page number to return based on the size.

pagination.pageSize
string <int64>

Page size is the maximum number of records to include per page.

Responses

Response samples

Content type
application/json
{
  • "dataServices": [
    ],
  • "pagination": {
    }
}

GetDataService API returns the the data service resource.

path Parameters
id
required
string

UID of the Data Service.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "info": {
    }
}