Add PostgreSQL Instance

This operation adds a PostgreSQL Instance in Client

application/json

Request Body

• instanceProperties object

  instance object

  instanceId integer

  instanceName string required

  Name of the Instance to be created

  applicationId integer required

  Default value: 125

  clientId integer

  clientName string required

  Client Name

  commCellId integer

  planEntity object

  planId integer required

  postGreSQLInstance object

  MaintainenceDB string required

  Maintenance DB name

  BinaryDirectory string required

  Binary Directory path

  LibDirectory string required

  Library Directory path

  ArchiveLogDirectory string

  Archive log Directory path

  port string required

  PostgreSQL database server port

  SAUser object

  userName string required

  Database User name

  password string required

  Database password

  osUser object

  userName string

  Os Username

  standbyOptions object

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

  clientId integer

  instanceName string

  Name of the instance created

  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": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "subclientId": 0,
      "clientId": 4,
      "instanceName": "pgauto1_4414_pg14",
      "instanceId": 6884,
      "_type_": 0
    }
  }
}

Bad Request

Response Headers

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 2

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "clientId": 0,
    "instanceName": "string",
    "instanceId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "An instance by this name already exists.",
  "errorCode": 3,
  "entity": {
    "subclientId": 0,
    "clientId": 5,
    "instanceName": "pgsqlwin_3306",
    "instanceId": -1,
    "_type_": 0
  }
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Port Number already in use
• Invalid Library Directory
• Invalid Binary Directory

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "clientId": 0,
    "instanceName": "string",
    "instanceId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "Provided Port Number [5432] is already in use. Please provide another port.",
  "errorCode": 1,
  "entity": {
    "subclientId": 0,
    "clientId": 4,
    "instanceName": "pgauto1_4414_pg14",
    "instanceId": -1,
    "_type_": 0
  }
}

{
  "errorMessage": "Connection to PostgreSQL Server failed.\n[~Unable to locate libpq.so library file in PostGres Lib directory. Please provide valid PostGres Lib Path~]",
  "errorCode": 4444,
  "entity": {
    "subclientId": 0,
    "clientId": 4,
    "instanceName": "pgauto1_4414_pg14",
    "instanceId": 6882,
    "_type_": 0
  }
}

{
  "errorMessage": "Invalid PostgreSQL bin directory.\n[~bin path directory:[/usr/pgsql-14] does not exist~]",
  "errorCode": 4444,
  "entity": {
    "subclientId": 0,
    "clientId": 4,
    "instanceName": "pgauto1_4414_pg14",
    "instanceId": 6883,
    "_type_": 0
  }
}

POST /instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

Content-Type

application/jsonapplication/xmlmultipart/form-datatext/html

Body

• Default
• Create PostgreSQL Instance

---

{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 125,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "BinaryDirectory": "string",
      "LibDirectory": "string",
      "ArchiveLogDirectory": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "osUser": {
        "userName": "string"
      },
      "standbyOptions": {}
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 125,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "BinaryDirectory": "string",
      "LibDirectory": "string",
      "ArchiveLogDirectory": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "osUser": {
        "userName": "string"
      },
      "standbyOptions": {}
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 125,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "BinaryDirectory": "string",
      "LibDirectory": "string",
      "ArchiveLogDirectory": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "osUser": {
        "userName": "string"
      },
      "standbyOptions": {}
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 125,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "BinaryDirectory": "string",
      "LibDirectory": "string",
      "ArchiveLogDirectory": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "osUser": {
        "userName": "string"
      },
      "standbyOptions": {}
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 125,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "BinaryDirectory": "string",
      "LibDirectory": "string",
      "ArchiveLogDirectory": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "osUser": {
        "userName": "string"
      },
      "standbyOptions": {}
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 125,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "BinaryDirectory": "string",
      "LibDirectory": "string",
      "ArchiveLogDirectory": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "osUser": {
        "userName": "string"
      },
      "standbyOptions": {}
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 125,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "BinaryDirectory": "string",
      "LibDirectory": "string",
      "ArchiveLogDirectory": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "osUser": {
        "userName": "string"
      },
      "standbyOptions": {}
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 125,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "postGreSQLInstance": {
      "MaintainenceDB": "string",
      "BinaryDirectory": "string",
      "LibDirectory": "string",
      "ArchiveLogDirectory": "string",
      "port": "string",
      "SAUser": {
        "userName": "string",
        "password": "string"
      },
      "osUser": {
        "userName": "string"
      },
      "standbyOptions": {}
    }
  }
}'