Lattice Hub Docs
HTTP OpenAPIConfig

Config groups

Create and query config groups.

Create and query config groups.

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

Config groups

Config group CRUD. Write bodies are usually ConfigFileGroup arrays (Enrich may show a single object).

GET/config/v1/groupsAuth required

List config groups

Search by namespace / group / fileName.

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    Namespace; empty means all.

  • groupquery · stringoptional

    Group name, fuzzy.

  • fileNamequery · stringoptional

    File name, fuzzy.

  • offsetquery · integeroptional

    Offset, default 0.

  • limitquery · integerrequired

    Page size, max 100, default 100.

Request
curl -sS 'http://127.0.0.1:8090/config/v1/groups?namespace=default&limit=20' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success",
  "configFileGroups": [{ "name": "docs-multi-gray" }]
}
POST/config/v1/groupsAuth required

Create config groups

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

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFileGroup[]required

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

  • idbody · stringoptional

    id

  • namebody · stringrequired

    name

  • namespacebody · stringrequired

    namespace

  • commentbody · stringoptional

    comment

  • businessbody · stringoptional

    business

  • departmentbody · stringoptional

    department

  • metadatabody · map<string,string>optional

    metadata

  • codebody · uint32required

    Business code; success is usually 200000.

  • infobody · stringoptional

    Info message.

  • configFileGroupbody · ConfigFileGroupoptional

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

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • commentbody · stringoptional

      comment

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • businessbody · stringoptional

      business

    • departmentbody · stringoptional

      department

    • metadatabody · map<string,string>optional

      metadata

    • file_countbody · uint64optional

      file_count

    • editablebody · booloptional

      删除操作标志位

    • deleteablebody · booloptional

      deleteable

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

Update config groups

Update groups; body is an array.

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFileGroup[]required

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

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • commentbody · stringoptional

    comment

  • businessbody · stringoptional

    business

  • departmentbody · stringoptional

    department

  • metadatabody · map<string,string>optional

    metadata

  • codebody · uint32required

    Business code; success is usually 200000.

  • infobody · stringoptional

    Info message.

  • configFileGroupbody · ConfigFileGroupoptional

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

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • commentbody · stringoptional

      comment

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • businessbody · stringoptional

      business

    • departmentbody · stringoptional

      department

    • metadatabody · map<string,string>optional

      metadata

    • file_countbody · uint64optional

      file_count

    • editablebody · booloptional

      删除操作标志位

    • deleteablebody · booloptional

      deleteable

Request
curl -sS -X PUT 'http://127.0.0.1:8090/config/v1/groups' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"docs-multi-gray","namespace":"default","comment":"updated"}]'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/config/v1/groups/deletteAuth required

Delete config groups

Note: control-plane path is delette (historical typo).

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFileGroup[]required

    JSON array of ConfigFileGroup; fields below are per-item.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • commentbody · stringoptional

    comment

  • businessbody · stringoptional

    business

  • departmentbody · stringoptional

    department

  • metadatabody · map<string,string>optional

    metadata

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ConfigFileGroupbody · ConfigFileGroupoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • commentbody · stringoptional

      comment

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • businessbody · stringoptional

      business

    • departmentbody · stringoptional

      department

    • metadatabody · map<string,string>optional

      metadata

    • file_countbody · uint64optional

      file_count

    • editablebody · booloptional

      editable

    • deleteablebody · booloptional

      deleteable

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

On this page