Create PostgreSQL Database Group

Select

SaaS

Customer Managed

This operation creates a database group in a PostgreSQL Instance

application/json

Request Body

• subClientProperties object

  subClientEntity object

  clientName string

  Client Name

  instanceName string

  Instance Name

  displayName string

  backupsetId integer

  _type_ string

  instanceId integer

  backupsetGUID string

  clientId integer

  appName string

  Default value: PostgreSQL

  Application Name

  backupsetName string

  BackupSet Name

  applicationId integer

  Default value: 125

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  subclientId integer

  Subclient ID

  subclientName string

  Subclient Name

  commonProperties object

  planEntity object

  planId integer

  Plan ID to be associated to the subclient

  contentOperationType integer

  content object[]

  postgreSQLContent object

  databaseName string

  Database name which needs to be added to contents

  postgreSQLSubclientProp object

  numberOfBackupStreams integer

  Default value: 1

  Number of backup streams

  collectObjectListDuringBackup boolean

  Flag to determine object list collection during backups

Responses

• 200
• 400
• 401
• 409
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  ID of create

  _type_ integer

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

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "subclientId": 21581,
      "_type_": 0
    }
  }
}

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Access denied",
  "errorCode": 5
}

Conflict

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "A subclient by this name already exists as part of this backup set.",
  "errorCode": 3
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Failed to create new subclient.",
  "errorCode": 1
}

{
  "errorMessage": "User does not have [Use Plan] rights on plan(s)-[Invalid PlanId].",
  "errorCode": 1
}

POST /subclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

Body

• Default
• Example (from schema)
• Create database groups with single databases in content
• Create database groups with multiple databases in content
• Create database group with number of backup streams
• Create database group with Collect object list option selected

---

{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "PostgreSQL",
      "backupsetName": "string",
      "applicationId": 125,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 1,
      "collectObjectListDuringBackup": true
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "PostgreSQL",
      "backupsetName": "string",
      "applicationId": 125,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 1,
      "collectObjectListDuringBackup": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "PostgreSQL",
      "backupsetName": "string",
      "applicationId": 125,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 1,
      "collectObjectListDuringBackup": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "PostgreSQL",
      "backupsetName": "string",
      "applicationId": 125,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 1,
      "collectObjectListDuringBackup": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "PostgreSQL",
      "backupsetName": "string",
      "applicationId": 125,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 1,
      "collectObjectListDuringBackup": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "PostgreSQL",
      "backupsetName": "string",
      "applicationId": 125,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 1,
      "collectObjectListDuringBackup": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "PostgreSQL",
      "backupsetName": "string",
      "applicationId": 125,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 1,
      "collectObjectListDuringBackup": true
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "PostgreSQL",
      "backupsetName": "string",
      "applicationId": 125,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 1,
      "collectObjectListDuringBackup": true
    }
  }
}'