Skip to main content

Retrieve a list of all reports

Contributors

GET /api/accounts/{accountId}/reports

Retrieves a list of all reports.

Parameters

Name Type In Required Description

accountId

string

path

True

NetApp tenancy account id

Response

Status: 200, Default Response

List of response

Definitions

See Definitions

credentials

CIFS credentials

Name Type Required Description

username

string

True

User name

password

string

True

password

domain

string

False

Domain

cifs

CIFS Details

Name Type Required Description

host

string

True

CIFS host

share

string

True

CIFS share

provider

string

True

CIFS type

path

string

False

CIFS path

version

string

False

Supported CIFS versions

workingEnvironmentId

string

False

Relevant working environment ID

credentials

credentials

False

CIFS credentials

nfs

NFS Details

Name Type Required Description

host

string

True

NFS host

export

string

True

NFS export

provider

string

True

NFS type

path

string

False

NFS path

version

string

False

Supported NFS versions

workingEnvironmentId

string

False

Relevant working environment ID

accessPoint

string

False

EFS access point

encryption

S3 encryption

Name Type Required Description

protocol

string

False

Encryption type

keyId

string

False

Encryption key arn in case it is kms encryption

tags

Name Type Required Description

key

string

False

Tag Key

value

string

False

Tag Value

glacier

Glacier storage class restore information (available only for s3 as source endpoint)

Name Type Required Description

days

number

True

Lifetime of the active copy in days

tier

string

True

Glacier retrieval tier at which the restore will be processed

deepArchive

Deep Archive storage class restore information (available only for s3 as source endpoint)

Name Type Required Description

days

number

True

Lifetime of the active copy in days

tier

string

True

Deep Archive retrieval tier at which the restore will be processed

s3

S3 details

Name Type Required Description

host

string

False

SGWS or IBM or ONTAP host

port

integer

False

SGWS or IBM or ONTAP port

bucket

string

True

Bucket

prefix

string

False

Prefix

region

string

False

Bucket region

encryption

encryption

False

S3 encryption

privateLinkDns

string

False

AWS S3 Private Link DNS

tags

array[tags]

False

storageClass

string

False

S3 Storage Class

provider

string

True

Object Storage Type

workingEnvironmentId

string

False

Relevant working environment ID - for storageGrid working environment

glacier

glacier

False

Glacier storage class restore information (available only for s3 as source endpoint)

deepArchive

deepArchive

False

Deep Archive storage class restore information (available only for s3 as source endpoint)

local

Local object details

Name Type Required Description

path

string

True

Local Path

azure

Azure Blob Storage Details

Name Type Required Description

container

string

True

Azure Blob Storage container name

storageAccountName

string

False

Azure Blob Storage account name

prefix

string

False

Container blob prefix

path

string

False

Container path, used in azure data lake storage

tags

array[tags]

False

blobTier

string

False

Blob tier type

provider

string

True

Azure type

gcp

Name Type Required Description

bucket

string

True

GCP Bucket

prefix

string

False

GCP Bucket prefix

tags

array[tags]

False

storageClass

string

False

GCP Storage Class

kmsKeyName

string

False

GCP Kms name

provider

string

True

GCP Type

gdrive

Name Type Required Description

driveId

string

True

Drive Id

driveName

string

False

Drive Name

folderId

string

False

Google Drive folderId

path

string

False

Folder path

provider

string

True

Google Drive Type

tags

array[tags]

False

subject

string

True

subject - user email

sftp

Name Type Required Description

host

string

True

SFTP host

port

integer

True

SFTP port number

path

string

False

Directory path

rootDirectory

string

True

Root Directory path

provider

string

True

SFTP Type

box

Name Type Required Description

rootDirectory

string

False

Root Directory

path

string

False

path

folderId

string

True

Folder Id

clientId

string

True

Client Id

appName

string

False

Box Application Name

enterpriseId

string

False

Enterprise Id

provider

string

True

Box Type

endpoint

Name Type Required Description

protocol

string

False

Endpoint protocol

cifs

cifs

False

CIFS Details

nfs

nfs

False

NFS Details

s3

s3

False

S3 details

local

local

False

Local object details

azure

azure

False

Azure Blob Storage Details

gcp

gcp

False

gdrive

gdrive

False

sftp

sftp

False

box

box

False

errors

Name Type Required Description

errorCode

string

False

Error Code

counter

number

False

How many times this error code appeared

description

string

False

Error code description

totals

Name Type Required Description

directories

number

False

Number of directories

files

number

False

Number of files

others

number

False

Number of others

objects

number

False

Number of objects

emptyObjects

number

False

Number of empty objects

size

number

False

Total size

failed

number

False

Total failed objects

statistics

Statistics of the given endpoint

Name Type Required Description

errors

array[errors]

False

totals

totals

False

response

Name Type Required Description

id

string

True

The Report internal ID

endpoint

endpoint

True

statistics

statistics

True

Statistics of the given endpoint

status

string

True

Reporter status

startTime

string

True

Start time

endTime

string

False

End time

duration

number

True

Total execution time of the reported

reason

string

False

Failure reason