v5

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-0330110112.1 KB

Dictionaries

Create or update Dictionaries from Dictionaries Spec

Create/update Dictionaries from Dictionaries Spec

put/organizations/{orgId}/environments/{envId}/dictionaries

Path parameters

orgIdstring required

Example:dedd0e0f-b3e9-4d2f-89cd-b2a9de7cb145

organization ID

envIdstring required

Example:a44e0d1b-9fa9-4d64-8b76-3634623a2e27

environment ID

Query parameters

dryRunboolean

Example:true

For modifying requests, this parameter allow you to test the result of an endpoint without actually persisting the state of the underlying spec.

Request body

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the dictionary

deployedboolean required

If true, a MANUAL type dictionary is deployed in the gateway, a DYNAMIC type dictionary is started. Changing this value back to false will stop the dictionary or undeploy it.

descriptionstring

Detailed description of the dictionary

type'MANUAL' | 'DYNAMIC' required

Type of dictionary. MANUAL is to be updated manually, DYNAMIC is updated and deployed automatically.

Example request

{
  "hrid": "demo_api"
}

Response

State of the successfully created/updated Dictionary

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the dictionary

deployedboolean required

If true, a MANUAL type dictionary is deployed in the gateway, a DYNAMIC type dictionary is started. Changing this value back to false will stop the dictionary or undeploy it.

descriptionstring

Detailed description of the dictionary

type'MANUAL' | 'DYNAMIC' required

Type of dictionary. MANUAL is to be updated manually, DYNAMIC is updated and deployed automatically.

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

Example response

{
  "hrid": "demo_api"
}