Dictionary

A Dictionary is a VCL data table that stores key-value pairs accessible to VCL during request processing. New, empty dictionaries can be attached to a draft version of a service, which must be activated for the dictionary to be included in VCL. Once installed, a dictionary's items may be updated via API calls without having to activate a new version of the associated service configuration. To remove a dictionary, delete it on a draft version of a service (one that is not locked and not active). Once removed, activate the draft service version without the dictionary.

Data model

created_atStringTime-stamp (UTC) when the dictionary was created.
deleted_atStringTime-stamp (UTC) when the dictionary was deleted.
idStringThe alphanumeric string identifying a dictionary.
nameStringName for the Dictionary.
service_idStringThe ID of the service to which the dictionary is attached.
updated_atStringTime-stamp (UTC) when the dictionary was updated.
versionIntegerThe version of the service to apply to the dictionary. The specified version must be unlocked to allow editing.
write_onlyBooleanDetermines if items in the dictionary are readable or not.

Endpoints

List edge dictionaries

GET/service/service_id/version/version/dictionary

Get an edge dictionary

GET/service/service_id/version/version/dictionary/name

Create an edge dictionary

POST/service/service_id/version/version/dictionary

Update an edge dictionary

PUT/service/service_id/version/version/dictionary/old_name

Delete an edge dictionary

DELETE/service/service_id/version/version/dictionary/name

User contributed notes

We welcome comments that add use cases, ideas, tips, and caveats. All comments will be moderated before publication. To post support questions, visit our support center and we'll find you the help you need.