Modify PostgreSQL Instance

Select

SaaS

Customer Managed

This operation is used to modify PostgreSQL instance property

Path Parameters

• instanceId integer required

  InstanceId of the PostgreSQL Instance

application/json

Request Body

• instanceProperties object

  instance object

  instanceId integer

  Instance ID

  instanceName string

  Instance Name

  applicationId integer

  clientId integer

  Client ID

  clientName string

  Client Name

  commCellId integer

  planEntity object

  planId integer

  Plan ID

  postGreSQLInstance object

  MaintainenceDB string

  BinaryDirectory string

  Binary directory Path

  LibDirectory string

  Library directory Path

  ArchiveLogDirectory string

  Archive log directory Path

  port string

  Port associated with PostgreSQL server

  SAUser object

  userName string

  osUser object

  userName string

  ArchiveDelete boolean

  standbyOptions object

  isStandbyEnabled boolean

Responses

• 200
• 400
• 401
• 403
• 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

  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": 0,
        "instanceName": "",
        "instanceId": 0,
        "_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
}

Forbidden

application/json

• Schema
• Example (from schema)
• Example 2

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "User does not have permission on the entity.",
  "errorCode": 587205847
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Failed to update properties because jobs are in progress for the Instance",
  "errorCode": 1
}

POST /instance/:instanceid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

instanceId — path required

Body

• Default
• Enabling Archive delete option
• Modifying Archive directory path
• Change the plan

---

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

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

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

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

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

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

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

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