Modify IBM Object storage instance

Select

SaaS

Customer Managed

IBM object storage modify instance operation

Path Parameters

• instanceId string required

  id of the instance which needs to be modified

application/json

Request Body

• instanceProperties object

  instance object required

  applicationId integer

  clientId integer

  instanceId integer

  cloudAppsInstance object required

  instanceTypeDisplayName string

  Possible values: [IBM Cloud Object Storage]

  instanceType string

  Possible values: [IBM_COS]

  generalCloudProperties object required

  numberOfBackupStreams integer

  Number of backup streams for default subclient

  memberServers object[]

  client object

  clientGroupName string

  Access nodes group name

  _type_ integer

  credentials object

  credentialName string

  objectStorageInstance object

  isCloudEncryptionKeySet boolean

  ibmCosInstance object required

  hostURL string

  credentialType string

  planEntity object required

  planName string
• association object required

  entity object[]

  clientName string

Responses

• 200
• 404

---

OK

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Unknown Instance information. Please provide valid instance id to complete the operation.",
  "errorCode": 587206385
}

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "string",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "string",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

POST /instance/:instanceid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/webconsole/api

Security Scheme

tokenbearerToken

token

instanceId — path required

Body

• Default
• Example 1

---

{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "IBM Cloud Object Storage",
      "instanceType": "IBM_COS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientGroupName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "ibmCosInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "IBM Cloud Object Storage",
      "instanceType": "IBM_COS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientGroupName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "ibmCosInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "IBM Cloud Object Storage",
      "instanceType": "IBM_COS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientGroupName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "ibmCosInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "IBM Cloud Object Storage",
      "instanceType": "IBM_COS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientGroupName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "ibmCosInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "IBM Cloud Object Storage",
      "instanceType": "IBM_COS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientGroupName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "ibmCosInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "IBM Cloud Object Storage",
      "instanceType": "IBM_COS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientGroupName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "ibmCosInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "IBM Cloud Object Storage",
      "instanceType": "IBM_COS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientGroupName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "ibmCosInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "IBM Cloud Object Storage",
      "instanceType": "IBM_COS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientGroupName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "ibmCosInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'