Create Parameter Group

POST

/dbaas/parameter-group/

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

Creates a parameter group for one engine version, from a template. A group stores only the values you send; every other parameter keeps the engine default. The API stores parameter names and values without checking them against the template; PostgreSQL checks them only when the group is applied to a database. Take names and allowed values from Get Parameter Group Template. The group’s engine version cannot be changed later. Needs the Create permission for DBaaS.

Parameters

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^required

Media typeapplication/json

object

name

required

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

template_id

required

The id of a template from List Parameter Group Templates.

integer

Example

3

description

Optional, 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

201

The new parameter group

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

errors

object

Example

{
  "code": 201,
  "message": "Created Successfully",
  "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"
    }
  },
  "errors": {}
}

400

A field is missing or breaks its rule: “Name is required.”, “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 “Template ID is required.”. 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": {
    "name": "Name must start with a lowercase letter and contain only lowercase letters, digits and hyphens (3-63 characters)."
  }
}

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."
}

412

No template with that ID is offered.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 412,
  "message": "Precondition Failed",
  "data": {},
  "errors": "Parameter group template not found."
}