Skip to main content

Get Snaps for a Job​

Select

SaaS
Customer Managed

API to list snaps for a particular Job Id

Path Parameters
  • jobId int32 required
Query Parameters
  • commcellId int32

    Default value: 2

Responses

OK

Schema
  • snaps object[]
  • smVolumeId int32

    The Volume Id of the snapshots

  • arrayName string

    Name of the array

  • arrayId int32

    Id of the array

  • sourceClientId int32

    Id of the Source Client

  • sourceClientName string

    Source client for the engine

  • sourcePath string

    Source path of the engine where disk is stored

  • mountHostId int32

    Id of the MA where the mount is hosted

  • mountHostName string

    Host on which the snapshot is mounted on

  • mountPath string

    Path to the mounted snapshot

  • appTypeId int32

    Id of the application type engine used

  • appTypeName string

    Name of the application type which the Engine used

  • masterJobId int32

    Job Id of the master job

  • jobId int32
  • creationTime int32

    Time of Creation

  • mountStatusId int32

    Id for the mount status

  • mountStatusName string

    Whether the snapshot was taken sucessfully or not

  • mountStatusUpdateTime int32

    Last Status Update

  • snapshotType int32

    The type of the snapshot

  • capabilities int32

    The capability flags set for the snapshot

GET /v4/storagearrays/job/:jobid/snaps

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
jobId — path required
commcellId — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StorageArrays/Job/:jobId/Snaps' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'