Lattice.Hub
GitHub

Lattice Hub Docs
HTTP OpenAPIConfig

Config gray release

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

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

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

Config gray release

Normal and gray publish; multiple active grays can coexist. Publish body is ConfigFileRelease.

POST/config/v1/files/releaseAuth required

Publish config

release_type is normal or gray; gray requires beta_labels.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFileRelease[]required

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

  • idbody · stringoptional

    id

  • namebody · stringrequired

    name

  • namespacebody · stringrequired

    namespace

  • groupbody · stringoptional

    group

  • file_namebody · stringoptional

    file_name

  • contentbody · stringoptional

    content

  • commentbody · stringoptional

    comment

  • versionbody · uint64optional

    version

  • labelsbody · map<string,string>optional

    labels

  • formatbody · stringoptional

    format

  • release_descriptionbody · stringoptional

    release_description

  • release_typebody · stringoptional

    release_type

  • beta_labelsbody · ClientLabel[]optional

    beta_labels

    • keybody · stringoptional

      key

    • valuebody · MatchStringoptional

      value

      • 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

  • 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

  • encryptedbody · booloptional

    是否为加密配置文件

  • encrypt_algobody · stringoptional

    加密算法

  • 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.

  • configFileReleasebody · ConfigFileReleaseoptional

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

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • groupbody · stringoptional

      group

    • file_namebody · stringoptional

      file_name

    • contentbody · stringoptional

      content

    • commentbody · stringoptional

      comment

    • md5body · stringoptional

      md5

    • versionbody · uint64optional

      version

    • ctimebody · stringoptional

      ctime

    • create_bybody · stringoptional

      create_by

    • mtimebody · stringoptional

      mtime

    • modify_bybody · stringoptional

      modify_by

    • labelsbody · map<string,string>optional

      labels

    • activebody · booloptional

      当前生效配置

    • formatbody · stringoptional

      format

    • release_descriptionbody · stringoptional

      release_description

    • release_typebody · stringoptional

      release_type

    • beta_labelsbody · ClientLabel[]optional

      beta_labels

      • keybody · stringoptional

        key

      • valuebody · MatchStringoptional

        value

        • 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

    • 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

    • encryptedbody · booloptional

      是否为加密配置文件

    • encrypt_algobody · stringoptional

      加密算法

    • 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/release' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"namespace":"default","group":"docs-multi-gray","file_name":"app.yaml","name":"gray-env-a","release_type":"gray","content":"mode: gray-a\n","beta_labels":[{"key":"env","value":{"type":0,"value":"gray-a","value_type":0}}]}'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
GET/config/v1/files/releasesAuth required

List config releases

List normal and gray releases.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    Namespace.

  • groupquery · stringoptional

    Group.

  • file_namequery · stringoptional

    File name (fileName also accepted).

  • namequery · stringoptional

    Release name (release_name also accepted).

  • only_activequery · booloptional

    Only active.

  • offsetquery · integeroptional

    Offset.

  • limitquery · integeroptional

    Page size.

Request
curl -sS 'http://127.0.0.1:8090/config/v1/files/releases?namespace=default&group=docs-multi-gray&file_name=app.yaml' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success",
  "data": [{ "name": "gray-env-a", "release_type": "gray", "active": true }]
}
GET/config/v1/files/release/versionsAuth required

List release versions

List release versions for a file.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringrequired

    Namespace.

  • groupquery · stringrequired

    Group.

  • file_namequery · stringrequired

    File name.

Request
curl -sS 'http://127.0.0.1:8090/config/v1/files/release/versions?namespace=default&group=docs-multi-gray&file_name=app.yaml' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/config/v1/files/releases/stopbetaAuth required

Stop gray release

Stop one gray release by version; body is ConfigFileRelease[].

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacebody · stringrequired

    Namespace.

  • groupbody · stringrequired

    Group.

  • file_namebody · stringrequired

    File name.

  • namebody · stringrequired

    Gray release name.

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

Rollback release

Roll back a config release; body is an array.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFileRelease[]required

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

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • groupbody · stringoptional

    group

  • file_namebody · stringoptional

    file_name

  • contentbody · stringoptional

    content

  • commentbody · stringoptional

    comment

  • versionbody · uint64optional

    version

  • labelsbody · map<string,string>optional

    labels

  • formatbody · stringoptional

    format

  • release_descriptionbody · stringoptional

    release_description

  • release_typebody · stringoptional

    release_type

  • beta_labelsbody · ClientLabel[]optional

    beta_labels

    • keybody · stringoptional

      key

    • valuebody · MatchStringoptional

      value

      • 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

  • 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

  • encryptedbody · booloptional

    是否为加密配置文件

  • encrypt_algobody · stringoptional

    加密算法

  • 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.

  • configFileReleasebody · ConfigFileReleaseoptional

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

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • groupbody · stringoptional

      group

    • file_namebody · stringoptional

      file_name

    • contentbody · stringoptional

      content

    • commentbody · stringoptional

      comment

    • md5body · stringoptional

      md5

    • versionbody · uint64optional

      version

    • ctimebody · stringoptional

      ctime

    • create_bybody · stringoptional

      create_by

    • mtimebody · stringoptional

      mtime

    • modify_bybody · stringoptional

      modify_by

    • labelsbody · map<string,string>optional

      labels

    • activebody · booloptional

      当前生效配置

    • formatbody · stringoptional

      format

    • release_descriptionbody · stringoptional

      release_description

    • release_typebody · stringoptional

      release_type

    • beta_labelsbody · ClientLabel[]optional

      beta_labels

      • keybody · stringoptional

        key

      • valuebody · MatchStringoptional

        value

        • 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

    • 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

    • encryptedbody · booloptional

      是否为加密配置文件

    • encrypt_algobody · stringoptional

      加密算法

    • 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/releases/rollback' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"namespace":"default","group":"docs-multi-gray","file_name":"app.yaml","name":"v1"}]'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/config/v1/files/releases/promote-grayAuth required

Promote gray to draft

Promote gray content into a draft; no Enrich docs—follow the handler.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFileRelease[]required

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

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • groupbody · stringoptional

    group

  • file_namebody · stringoptional

    file_name

  • contentbody · stringoptional

    content

  • commentbody · stringoptional

    comment

  • versionbody · uint64optional

    version

  • labelsbody · map<string,string>optional

    labels

  • formatbody · stringoptional

    format

  • release_descriptionbody · stringoptional

    release_description

  • release_typebody · stringoptional

    release_type

  • beta_labelsbody · ClientLabel[]optional

    beta_labels

    • keybody · stringoptional

      key

    • valuebody · MatchStringoptional

      value

      • 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

  • 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

  • encryptedbody · booloptional

    是否为加密配置文件

  • encrypt_algobody · stringoptional

    加密算法

  • 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.

  • configFileReleasebody · ConfigFileReleaseoptional

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

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • groupbody · stringoptional

      group

    • file_namebody · stringoptional

      file_name

    • contentbody · stringoptional

      content

    • commentbody · stringoptional

      comment

    • md5body · stringoptional

      md5

    • versionbody · uint64optional

      version

    • ctimebody · stringoptional

      ctime

    • create_bybody · stringoptional

      create_by

    • mtimebody · stringoptional

      mtime

    • modify_bybody · stringoptional

      modify_by

    • labelsbody · map<string,string>optional

      labels

    • activebody · booloptional

      当前生效配置

    • formatbody · stringoptional

      format

    • release_descriptionbody · stringoptional

      release_description

    • release_typebody · stringoptional

      release_type

    • beta_labelsbody · ClientLabel[]optional

      beta_labels

      • keybody · stringoptional

        key

      • valuebody · MatchStringoptional

        value

        • 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

    • 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

    • encryptedbody · booloptional

      是否为加密配置文件

    • encrypt_algobody · stringoptional

      加密算法

    • 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/releases/promote-gray' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"namespace":"default","group":"docs-multi-gray","file_name":"app.yaml","name":"gray-env-a"}'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
GET/config/v1/files/releaseAuth required

Get current release

Get current release.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    namespace

  • groupquery · stringoptional

    group

  • namequery · stringoptional

    name

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

Delete releases

Delete releases.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ConfigFileRelease[]required

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

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • groupbody · stringoptional

    group

  • file_namebody · stringoptional

    file_name

  • contentbody · stringoptional

    content

  • commentbody · stringoptional

    comment

  • versionbody · uint64optional

    version

  • labelsbody · map<string,string>optional

    labels

  • formatbody · stringoptional

    format

  • release_descriptionbody · stringoptional

    release_description

  • release_typebody · stringoptional

    release_type

  • beta_labelsbody · ClientLabel[]optional

    beta_labels

    • keybody · stringoptional

      key

    • valuebody · MatchStringoptional

      value

      • 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

  • 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

  • encryptedbody · booloptional

    encrypted

  • encrypt_algobody · stringoptional

    encrypt_algo

  • config_typebody · enum(ConfigFileType)optional

    config_type enum: CONFIG_FILE | CONFIG_TEMPLATE

  • placeholder_value_mapbody · map<string,PlaceholderValue>optional

    placeholder_value_map

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ConfigFileReleasebody · ConfigFileReleaseoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • groupbody · stringoptional

      group

    • file_namebody · stringoptional

      file_name

    • contentbody · stringoptional

      content

    • commentbody · stringoptional

      comment

    • md5body · stringoptional

      md5

    • versionbody · uint64optional

      version

    • ctimebody · stringoptional

      ctime

    • create_bybody · stringoptional

      create_by

    • mtimebody · stringoptional

      mtime

    • modify_bybody · stringoptional

      modify_by

    • labelsbody · map<string,string>optional

      labels

    • activebody · booloptional

      active

    • formatbody · stringoptional

      format

    • release_descriptionbody · stringoptional

      release_description

    • release_typebody · stringoptional

      release_type

    • beta_labelsbody · ClientLabel[]optional

      beta_labels

      • keybody · stringoptional

        key

      • valuebody · MatchStringoptional

        value

        • 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

    • 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

    • encryptedbody · booloptional

      encrypted

    • encrypt_algobody · stringoptional

      encrypt_algo

    • config_typebody · enum(ConfigFileType)optional

      config_type enum: CONFIG_FILE | CONFIG_TEMPLATE

    • placeholder_value_mapbody · map<string,PlaceholderValue>optional

      placeholder_value_map

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

Create and publish

Create and publish.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • release_namebody · stringoptional

    release_name

  • namespacebody · stringoptional

    namespace

  • groupbody · stringoptional

    group

  • file_namebody · stringoptional

    file_name

  • contentbody · stringoptional

    content

  • commentbody · stringoptional

    comment

  • formatbody · stringoptional

    format

  • release_descriptionbody · stringoptional

    release_description

  • labelsbody · map<string,string>optional

    labels

  • encryptedbody · booloptional

    encrypted

  • encrypt_algobody · stringoptional

    encrypt_algo

  • 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

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ConfigFilePublishInfobody · ConfigFilePublishInfooptional

    Entity fields.

    • release_namebody · stringoptional

      release_name

    • namespacebody · stringoptional

      namespace

    • groupbody · stringoptional

      group

    • file_namebody · stringoptional

      file_name

    • contentbody · stringoptional

      content

    • commentbody · stringoptional

      comment

    • formatbody · stringoptional

      format

    • release_descriptionbody · stringoptional

      release_description

    • labelsbody · map<string,string>optional

      labels

    • md5body · stringoptional

      md5

    • encryptedbody · booloptional

      encrypted

    • encrypt_algobody · stringoptional

      encrypt_algo

    • 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

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

Op / release history

Op / release history.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    namespace

  • groupquery · stringoptional

    group

  • namequery · stringoptional

    name

  • offsetquery · integeroptional

    offset

  • limitquery · integeroptional

    limit

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

Release history (legacy)

Release history (legacy).

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    namespace

  • groupquery · stringoptional

    group

  • namequery · stringoptional

    name

  • offsetquery · integeroptional

    offset

  • limitquery · integeroptional

    limit

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

Config files

Read, write, and search config files.

Config templates

Config file template management.

On this page

POST Publish configGET List config releasesGET List release versionsPOST Stop gray releasePUT Rollback releasePOST Promote gray to draftGET Get current releasePOST Delete releasesPOST Create and publishGET Op / release historyGET Release history (legacy)