API Reference

Search archives

get
https://{host}/platform/admindata/v1/archives
Query Params
string

Query string to select response data based on property values. Supported properties: archiveName, archiveId, archivedBy, serverName, createdAt, createdBy, expirationDate, serverType, sourceTypeId, storageTypeId, tagIds . Depending on the property, you may use comparison operators, list operators, and logical operators.

PropertyTypeComparisonList
archiveIdNumber=, !=IN, NOT IN
archiveNameString=, !=, LIKE, NOT LIKEIN, NOT IN
archiveSubTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
archiveTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
archivedByString=, !=, LIKE, NOT LIKEIN, NOT IN
createdAtYYYY-MM-DD=, !=, >, >=, <, <=, LIKE, NOT LIKE
createdByString=, !=, LIKE, NOT LIKEIN, NOT IN
databaseTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
expirationDateYYYY-MM-DD=, !=, >, >=, <, <=, LIKE, NOT LIKE
ownerString=, !=, LIKE, NOT LIKEIN, NOT IN
serverNameString=, !=, LIKE, NOT LIKEIN, NOT IN
serverTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
sizeInMbNumber=, !=, >, >=, <, <=
sourceTypeIdNumber=, !=, LIKE, NOT LIKEIN, NOT IN
sourceTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
storageTypeIdNumber=, !=, LIKE, NOT LIKEIN, NOT IN
storageTypeNumber=, !=, LIKE, NOT LIKEIN, NOT IN
tagIdsNumber=, !=IN, NOT IN

See Filtering Responses.

string
Defaults to archiveName ASC

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: archivedBy, archiveId, archiveName, archiveSubType, archiveType, createdAt, createdBy, databaseType, expirationDate, owner, serverName, serverType, sizeInMb, storageType, storageTypeId, tagIds.
See Response Pagination.

int32
1 to 1000
Defaults to 100

Number of records to display on the page.

int32
≥ 0
Defaults to 0

Number of the page displaying the returned records, starting at '0'.

Responses

Updated about 6 hours ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 6 hours ago

Did this page help you?