Loading...

REST API - POST Storage Policy

This operation creates a storage policy. To create a storage policy using request parameters, see REST API - PUT Storage Policy.

Request

Syntax

Send the request using either XML or JSON:

  • XML

    POST <webservice>/V2/StoragePolicy
    Host: <host name>
    Accept: application/xml
    Authtoken: <authentication token>
    Content-type: application/xml

    <SP_creation.xml>

  • JSON

    POST <webservice>/V2/StoragePolicy
    Host: <host name>
    Accept: application/json
    Authtoken: <authentication token>
    Content-type: application/json

    <SP_creation.json>

where <webservice> is the root path that routes the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Body

Download the XML or JSON file that is required for this request: SP_creation.xml or SP_creation.json. The following table displays the parameters for the request body.

Name

Description

Element

Parent Element

storagePolicyName

The name of the storage policy.

App_CreateStoragePolicyReq

 

libraryName

The name of the library.

library

storagePolicyCopyInfo

mediaAgentName

The name of the MediaAgent that is associated with the storage policy.

mediaAgent

storagePolicyCopyInfo

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token that you receive after successfully logging on. For information about receiving an authentication token, see Authentication.

Content-type

The media type that is contained in the request body.

Response

Response Parameters

Parameter

Description

Element

responseType

 

App_CreateStoragePolicyResp

_type_

 

archiveGroupCopy

copyId

The system-generated ID of the copy.

archiveGroupCopy

copyName

The name of the storage policy copy.

archiveGroupCopy

storagePolicyId

The system-generated ID of the storage policy.

archiveGroupCopy

storagePolicyName

The name of the storage policy.

archiveGroupCopy

errorCode

The possible error codes.

Valid values are:

  • 0, a successful completion.
  • 2, a failure.
  • a specific error code.

error

Examples

Sample Request

This request creates a storage policy.

XML

POST <webservice>/V2/StoragePolicy HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<App_CreateStoragePolicyReq storagePolicyName="SP1">
  <storagePolicyCopyInfo>
    <library libraryName="Library1"/>
    <mediaAgent mediaAgentName="MA1"/>
    <retentionRules retainBackupDataForDays="120"/>
  </storagePolicyCopyInfo>
</App_CreateStoragePolicyReq>

JSON

POST <webservice>/V2/StoragePolicy HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json

<App_CreateStoragePolicyReq storagePolicyName="SP1">
  <storagePolicyCopyInfo>
    <library libraryName="Library1"/>
    <mediaAgent mediaAgentName="MA1"/>
    <retentionRules retainBackupDataForDays="120"/>
  </storagePolicyCopyInfo>
</App_CreateStoragePolicyReq>

Sample Response

XML

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_CreateStoragePolicyResp responseType="0">
<archiveGroupCopy _type_="18" copyId="660" copyName="Primary" storagePolicyId="365" storagePolicyName="SP1"/>
<error errorCode="0"/>
</App_CreateStoragePolicyResp>

JSON

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_CreateStoragePolicyResp responseType="0">
<archiveGroupCopy _type_="18" copyId="660" copyName="Primary" storagePolicyId="365" storagePolicyName="SP1"/>
<error errorCode="0"/>
</App_CreateStoragePolicyResp>

Last modified: 10/9/2018 8:50:20 AM