Skip to main content

Get PostgreSQL Instances associated to a client​

Select

SaaS
Customer Managed

Get the properties of PostgreSQL Instances associated to the client

Query Parameters
  • clientName string required

    Name of the client

  • appName string required

    Default value: PostgreSQL

    Application name is PostgreSQL

Responses

OK

Schema
  • instanceProperties object[]
  • isDeleted boolean
  • applicationSize integer
  • excludeFromSLA boolean
  • version string
  • scIdxEnabled integer
  • isSnapEnabled boolean
  • autoDiscovered boolean
  • instance object
  • clientName string

    Client name

  • instanceName string

    Name of the instance

  • displayName string
  • instanceId integer
  • instanceGUID string
  • clientId integer
  • appName string

    Default value: PostgreSQL

  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • postGreSQLInstance object
  • BinaryDirectory string

    Binary directory path

  • ArchiveDelete boolean

    Archive delete flag

  • useGCPApi boolean
  • ArchiveLogDirectory string

    Archive log directory path

  • isStandBy boolean
  • lastLogNumber string

    Last log number backed up

  • MaintainenceDB string
  • useClientCloudCredentials boolean
  • planSchedAssocType integer
  • LibDirectory string

    Library directory path

  • port string

    Port of PostgreSQL instance

  • sslOpt object
  • sslCa string
  • sslEnabled boolean
  • sslKey string
  • sslCert string
  • logStoragePolicy object
  • storagePolicyName string

    Storage Policy name

  • storagePolicyId integer
  • UNCUser object
  • userName string
  • standbyOptions object
  • useMasterForLogBkp boolean
  • isStandbyEnabled boolean
  • useMasterForDataBkp boolean
  • standbyInstance object
  • instanceName string
  • instanceId integer
  • SAUser object
  • userName string
  • osUser object
  • userName string
  • gcpOptions object
  • stagingBucketURI string
  • dumpFileType integer
  • useCompression boolean
  • clusterSettings object
  • instanceActivityControl object
  • activityControlOptions object[]
  • activityType integer
  • enableAfterADelay boolean
  • enableActivityType boolean
  • cloudDBInstance object
  • overRideAccessNode boolean
  • accessNodes object
GET /instance

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
token
clientName — query required
appName — query required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'