Lattice.Hub
GitHub

Lattice Hub Docs
HTTP OpenAPIConfig

Config files

Read, write, and search config files.

Read, write, and search config files.

Default Base URL: http://127.0.0.1:8090. Management APIs require Authorization (token from login).

Config files

Read/write/search config files. Publishing is under Config gray. Write bodies are usually ConfigFile arrays.

GET/config/v1/files/detailAuth required

Get config file

Read config file detail from the management surface.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringrequired

    Namespace.

  • groupquery · stringrequired

    Group.

  • namequery · stringrequired

    File name.

Request
curl -sS 'http://127.0.0.1:8090/config/v1/files/detail?namespace=default&group=docs-multi-gray&name=app.yaml' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success",
  "configFile": { "name": "app.yaml", "content": "mode: baseline" }
}
GET/config/v1/files/searchAuth required

Search config files

Search config files by filters.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    Namespace.

  • groupquery · stringoptional

    Group.

  • namequery · stringoptional

    File name.

  • tagsquery · stringoptional

    Tags as key1,value1,key2,value2.

  • offsetquery · integeroptional

    Offset.

  • limitquery · integerrequired

    Page size, default 100.

Request
curl -sS 'http://127.0.0.1:8090/config/v1/files/search?namespace=default&group=docs-multi-gray&limit=20' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/config/v1/filesAuth required

Create config files

Write bodies are usually protobuf message arrays; fields below are per-object (see specification).

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFile[]required

    Request body is a JSON array of ConfigFile: [{...}, ...]. Fields below are the full per-item schema (including nested).

  • idbody · stringoptional

    id

  • namebody · stringrequired

    name

  • namespacebody · stringrequired

    namespace

  • groupbody · stringoptional

    group

  • contentbody · stringoptional

    content

  • formatbody · stringoptional

    format

  • commentbody · stringoptional

    comment

  • labelsbody · map<string,string>optional

    labels

  • encryptedbody · booloptional

    是否为加密配置文件

  • encrypt_algobody · stringoptional

    加密算法

  • supported_clientbody · enum(ConfigFileSupportedClient)optional

    supported_client enum: CLIENT_SDK | CLIENT_AGENT | CLIENT_ALL

  • persistentbody · ConfigFilePersistentoptional

    persistent

    • encodingbody · stringoptional

      encoding

    • pathbody · stringoptional

      path

    • post_cmdbody · stringoptional

      post_cmd

  • config_typebody · enum(ConfigFileType)optional

    config_type enum: CONFIG_FILE | CONFIG_TEMPLATE

  • placeholder_value_mapbody · map<string,PlaceholderValue>optional

    placeholder_value_map

    • placeholderbody · stringoptional

      占位符名称

    • valuesbody · MatchString[]optional

      values

      • typebody · enum(MatchStringType)optional

        type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE

      • valuebody · stringoptional

        value

      • value_typebody · enum(ValueType)optional

        value_type enum: TEXT | PARAMETER

Response fields

  • codebody · uint32required

    Business code; success is usually 200000.

  • infobody · stringoptional

    Info message.

  • configFilebody · ConfigFileoptional

    ConfigFile entity fields (batch APIs nest under responses[]).

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • groupbody · stringoptional

      group

    • contentbody · stringoptional

      content

    • formatbody · stringoptional

      format

    • commentbody · stringoptional

      comment

    • statusbody · stringoptional

      status

    • labelsbody · map<string,string>optional

      labels

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • rtimebody · stringoptional

      rtime

    • encryptedbody · booloptional

      是否为加密配置文件

    • encrypt_algobody · stringoptional

      加密算法

    • supported_clientbody · enum(ConfigFileSupportedClient)optional

      supported_client enum: CLIENT_SDK | CLIENT_AGENT | CLIENT_ALL

    • persistentbody · ConfigFilePersistentoptional

      persistent

      • encodingbody · stringoptional

        encoding

      • pathbody · stringoptional

        path

      • post_cmdbody · stringoptional

        post_cmd

    • config_typebody · enum(ConfigFileType)optional

      config_type enum: CONFIG_FILE | CONFIG_TEMPLATE

    • placeholder_value_mapbody · map<string,PlaceholderValue>optional

      placeholder_value_map

      • placeholderbody · stringoptional

        占位符名称

      • valuesbody · MatchString[]optional

        values

        • typebody · enum(MatchStringType)optional

          type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE

        • valuebody · stringoptional

          value

        • value_typebody · enum(ValueType)optional

          value_type enum: TEXT | PARAMETER

Request
curl -sS -X POST 'http://127.0.0.1:8090/config/v1/files' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"namespace":"default","group":"docs-multi-gray","name":"app.yaml","content":"mode: baseline\n","format":"yaml"}]'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
PUT/config/v1/filesAuth required

Update config files

Update draft content; body is an array.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFile[]required

    Request body is a JSON array of ConfigFile: [{...}, ...]. Fields below are the full per-item schema (including nested).

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • groupbody · stringoptional

    group

  • contentbody · stringoptional

    content

  • formatbody · stringoptional

    format

  • commentbody · stringoptional

    comment

  • labelsbody · map<string,string>optional

    labels

  • encryptedbody · booloptional

    是否为加密配置文件

  • encrypt_algobody · stringoptional

    加密算法

  • supported_clientbody · enum(ConfigFileSupportedClient)optional

    supported_client enum: CLIENT_SDK | CLIENT_AGENT | CLIENT_ALL

  • persistentbody · ConfigFilePersistentoptional

    persistent

    • encodingbody · stringoptional

      encoding

    • pathbody · stringoptional

      path

    • post_cmdbody · stringoptional

      post_cmd

  • config_typebody · enum(ConfigFileType)optional

    config_type enum: CONFIG_FILE | CONFIG_TEMPLATE

  • placeholder_value_mapbody · map<string,PlaceholderValue>optional

    placeholder_value_map

    • placeholderbody · stringoptional

      占位符名称

    • valuesbody · MatchString[]optional

      values

      • typebody · enum(MatchStringType)optional

        type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE

      • valuebody · stringoptional

        value

      • value_typebody · enum(ValueType)optional

        value_type enum: TEXT | PARAMETER

Response fields

  • codebody · uint32required

    Business code; success is usually 200000.

  • infobody · stringoptional

    Info message.

  • configFilebody · ConfigFileoptional

    ConfigFile entity fields (batch APIs nest under responses[]).

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • groupbody · stringoptional

      group

    • contentbody · stringoptional

      content

    • formatbody · stringoptional

      format

    • commentbody · stringoptional

      comment

    • statusbody · stringoptional

      status

    • labelsbody · map<string,string>optional

      labels

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • rtimebody · stringoptional

      rtime

    • encryptedbody · booloptional

      是否为加密配置文件

    • encrypt_algobody · stringoptional

      加密算法

    • supported_clientbody · enum(ConfigFileSupportedClient)optional

      supported_client enum: CLIENT_SDK | CLIENT_AGENT | CLIENT_ALL

    • persistentbody · ConfigFilePersistentoptional

      persistent

      • encodingbody · stringoptional

        encoding

      • pathbody · stringoptional

        path

      • post_cmdbody · stringoptional

        post_cmd

    • config_typebody · enum(ConfigFileType)optional

      config_type enum: CONFIG_FILE | CONFIG_TEMPLATE

    • placeholder_value_mapbody · map<string,PlaceholderValue>optional

      placeholder_value_map

      • placeholderbody · stringoptional

        占位符名称

      • valuesbody · MatchString[]optional

        values

        • typebody · enum(MatchStringType)optional

          type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE

        • valuebody · stringoptional

          value

        • value_typebody · enum(ValueType)optional

          value_type enum: TEXT | PARAMETER

Request
curl -sS -X PUT 'http://127.0.0.1:8090/config/v1/files' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"namespace":"default","group":"docs-multi-gray","name":"app.yaml","content":"mode: next\n"}]'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/config/v1/files/deleteAuth required

Delete config files

Delete files; handler uses a body array (Enrich may document query).

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFile[]required

    Request body is a JSON array of ConfigFile: [{...}, ...]. Fields below are the full per-item schema (including nested).

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • groupbody · stringoptional

    group

  • contentbody · stringoptional

    content

  • formatbody · stringoptional

    format

  • commentbody · stringoptional

    comment

  • labelsbody · map<string,string>optional

    labels

  • encryptedbody · booloptional

    是否为加密配置文件

  • encrypt_algobody · stringoptional

    加密算法

  • supported_clientbody · enum(ConfigFileSupportedClient)optional

    supported_client enum: CLIENT_SDK | CLIENT_AGENT | CLIENT_ALL

  • persistentbody · ConfigFilePersistentoptional

    persistent

    • encodingbody · stringoptional

      encoding

    • pathbody · stringoptional

      path

    • post_cmdbody · stringoptional

      post_cmd

  • config_typebody · enum(ConfigFileType)optional

    config_type enum: CONFIG_FILE | CONFIG_TEMPLATE

  • placeholder_value_mapbody · map<string,PlaceholderValue>optional

    placeholder_value_map

    • placeholderbody · stringoptional

      占位符名称

    • valuesbody · MatchString[]optional

      values

      • typebody · enum(MatchStringType)optional

        type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE

      • valuebody · stringoptional

        value

      • value_typebody · enum(ValueType)optional

        value_type enum: TEXT | PARAMETER

Response fields

  • codebody · uint32required

    Business code; success is usually 200000.

  • infobody · stringoptional

    Info message.

  • configFilebody · ConfigFileoptional

    ConfigFile entity fields (batch APIs nest under responses[]).

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • groupbody · stringoptional

      group

    • contentbody · stringoptional

      content

    • formatbody · stringoptional

      format

    • commentbody · stringoptional

      comment

    • statusbody · stringoptional

      status

    • labelsbody · map<string,string>optional

      labels

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • rtimebody · stringoptional

      rtime

    • encryptedbody · booloptional

      是否为加密配置文件

    • encrypt_algobody · stringoptional

      加密算法

    • supported_clientbody · enum(ConfigFileSupportedClient)optional

      supported_client enum: CLIENT_SDK | CLIENT_AGENT | CLIENT_ALL

    • persistentbody · ConfigFilePersistentoptional

      persistent

      • encodingbody · stringoptional

        encoding

      • pathbody · stringoptional

        path

      • post_cmdbody · stringoptional

        post_cmd

    • config_typebody · enum(ConfigFileType)optional

      config_type enum: CONFIG_FILE | CONFIG_TEMPLATE

    • placeholder_value_mapbody · map<string,PlaceholderValue>optional

      placeholder_value_map

      • placeholderbody · stringoptional

        占位符名称

      • valuesbody · MatchString[]optional

        values

        • typebody · enum(MatchStringType)optional

          type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE

        • valuebody · stringoptional

          value

        • value_typebody · enum(ValueType)optional

          value_type enum: TEXT | PARAMETER

Request
curl -sS -X POST 'http://127.0.0.1:8090/config/v1/files/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"namespace":"default","group":"docs-multi-gray","name":"app.yaml"}]'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/config/v1/files/exportAuth required

Export config files

Export config files.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacebody · stringoptional

    namespace

  • groupsbody · string[]optional

    groups

  • namesbody · string[]optional

    names

  • idsbody · uint64[]optional

    ids

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ConfigFileExportRequestbody · ConfigFileExportRequestoptional

    Entity fields.

    • namespacebody · stringoptional

      namespace

    • groupsbody · string[]optional

      groups

    • namesbody · string[]optional

      names

    • idsbody · uint64[]optional

      ids

Request
curl -sS -X POST 'http://127.0.0.1:8090/config/v1/files/export' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
POST/config/v1/files/importAuth required

Import config files

multipart/form-data upload.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    namespace

  • groupquery · stringoptional

    group

Request
curl -sS -X POST 'http://127.0.0.1:8090/config/v1/files/import' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/config/v1/files/encrypt/algorithmsAuth required

Encrypt algorithms

Encrypt algorithms.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

Request
curl -sS -X GET 'http://127.0.0.1:8090/config/v1/files/encrypt/algorithms' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/config/v1/files/subscribersAuth required

Config subscribers

Config subscribers.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    namespace

  • groupquery · stringoptional

    group

Request
curl -sS -X GET 'http://127.0.0.1:8090/config/v1/files/subscribers' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/config/v1/files/client/subscriptionAuth required

Client subscription

Client subscription.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    namespace

  • groupquery · stringoptional

    group

Request
curl -sS -X GET 'http://127.0.0.1:8090/config/v1/files/client/subscription' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/config/v1/fileAuth required

Get config file (legacy path)

default-read alias of /files/detail.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringrequired

    namespace

  • groupquery · stringrequired

    group

  • namequery · stringrequired

    name

Request
curl -sS -X GET 'http://127.0.0.1:8090/config/v1/file' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/config/v1/files/encryptalgorithmAuth required

Encrypt algorithm (legacy)

Alias of /files/encrypt/algorithms.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

Request
curl -sS -X GET 'http://127.0.0.1:8090/config/v1/files/encryptalgorithm' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}

Config groups

Create and query config groups.

Config gray release

Normal / gray publish, stop gray, and promote drafts.

On this page

GET Get config fileGET Search config filesPOST Create config filesPUT Update config filesPOST Delete config filesPOST Export config filesPOST Import config filesGET Encrypt algorithmsGET Config subscribersGET Client subscriptionGET Get config file (legacy path)GET Encrypt algorithm (legacy)