Update Parameter Group

PUT

/dbaas/parameter-group/{pg_id}/

curl --request PUT \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/dbaas/parameter-group/{pg_id}/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "high-connections",
  "description": "More connections for the API workers",
  "parameters": {
    "max_connections": "200",
    "work_mem": "8MB"
  }
}'

Changes a parameter group’s name, description or values. Works only on a group you created in the project; any other ID returns 404. Every field is optional; send only what changes. parameters, when sent, replaces the group’s whole set of values. Values are only ever set on a database, never reset: a value you leave out is removed from the group, but it stays in force on every database that already applied it. New values are applied at once to every database that uses the group and is Running or Scaling, without a restart; values PostgreSQL reads only at start-up take effect at the next restart. The group is saved even where a database could not take the values; those databases are named in apply_failed; detach the group from such a database and attach it again to apply the values. Needs the Update permission for DBaaS.

Parameters

Path Parameters

pg_id

required

integer

Parameter group ID

Query Parameters

project_id

required

integer

Project ID

active_iam

integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location

required

string

Allowed values: Delhi Chennai

Location

Request Body

Media typeapplication/json

object

name

3 to 63 characters: a lowercase letter first, then lowercase letters, numbers and hyphens. Two parameter groups may have the same name.

string

>= 3 characters <= 63 characters /^[a-z][a-z0-9-]{2,62}$/

Example

high-connections

description

Up to 255 characters.

string

<= 255 characters

Example

More connections for the API workers

parameters

The values this group changes, as parameter name to value. Parameters not listed keep the engine default.

object

key

additional properties

string

Example

{
  "max_connections": "200",
  "work_mem": "8MB"
}

Responses

200

The parameter group as saved

Media typeapplication/json

object

code

integer

message

string

data

object

id

integer

name

string

description

string

family

Engine and version the group is for.

string

template_id

integer

parameters

The values this group changes, as parameter name to value. Parameters not listed keep the engine default.

object

key

additional properties

string

template_parameters

Array<object>

object

parameterName

string

parameterValue

The engine default. In a parameter group’s template_parameters, the group’s own value where it changes this parameter.

string

nullable

dataType

For example integer, real, bool, enum or string.

string

allowedValues

A range such as 1-262143 for numbers, or comma-separated choices for enum.

string

nullable

description

string

nullable

isModifiable

false for a parameter that cannot be changed.

boolean

applyType

The category the parameter belongs to.

string

nullable

is_attached

boolean

apply_failed

Names of the databases that did not take the new values: not Running or Scaling, or the values were refused.

Array<string>

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": 17,
    "name": "high-connections",
    "description": "More connections for the API workers",
    "family": "postgresql-16",
    "template_id": 3,
    "parameters": {
      "max_connections": "200",
      "work_mem": "8MB"
    },
    "template_parameters": [
      {
        "parameterName": "max_connections",
        "parameterValue": "100",
        "dataType": "integer",
        "allowedValues": "1-262143",
        "description": "Sets the maximum number of concurrent connections.",
        "isModifiable": true,
        "applyType": "Connections / Authentication"
      }
    ],
    "is_attached": true,
    "apply_failed": []
  },
  "errors": {}
}

400

A field breaks its rule: “Name must start with a lowercase letter and contain only lowercase letters, digits and hyphens (3-63 characters).”, “Description must be at most 255 characters.” or “parameters must be an object.”. A missing or invalid project ID gives errors “Project ID is missing or invalid”.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

object

Example

{
  "code": 400,
  "message": "Bad Request",
  "data": {},
  "errors": {
    "parameters": "parameters must be an object."
  }
}

403

The caller lacks the permission the call needs on the project, or the region is not allowed.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 403,
  "message": "Forbidden",
  "data": {},
  "errors": "You don't have permission to access this service. Please verify your policy or project."
}

404

No parameter group with that ID among yours in the project.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 404,
  "message": "Bad Request",
  "data": {},
  "errors": "Parameter group not found."
}