Get PostgreSQL Instance ID and database group ID

Select

SaaS

Customer Managed

Get PostgreSQL Instance ID using client name and instance name

Query Parameters

• clientName string required

  Name of the client

• agent string required

  Default value: PostgreSQL

  PostgreSQL

• instanceName string required

  Name of the PostgreSQL Instance

Responses

• 200
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Get Instance I D

---

Schema

• clientId integer

  Client ID

• instanceName string

  PostgreSQL Instance name

• appName string

  PostgreSQL

• applicationId integer

  Default value: 125

  PostgreSQL application ID

• clientName string

  Client Name

• instanceId integer

  PostgreSQL Instance ID

• _type_ integer

{
  "clientId": 0,
  "instanceName": "string",
  "appName": "string",
  "applicationId": 125,
  "clientName": "string",
  "instanceId": 0,
  "_type_": 0
}

{
  "clientId": 4,
  "instanceName": "pgauto1_5432",
  "appName": "PostgreSQL",
  "applicationId": 125,
  "clientName": "pgauto1",
  "instanceId": 13,
  "_type_": 5
}

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

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

Not Found

Response Headers

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "No client/instance is specified",
  "errorCode": 4
}

Loading...