Docs
Elastic Cloud Enterprise Reference [2.2] » RESTful API » API reference » Platform - configuration - Store
«  Platform - Runners     Platform - proxies  »

Platform - configuration - Store

List Config Store Option

List all existing Config Store Option.

Request

GET /api/v1/platform/configuration/store

Responses

200
(ConfigStoreOptionList) List of existing Config Store Option
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/configuration/store \
-u $CLOUD_USER:$CLOUD_KEY

Delete Config Store Option by name

Delete Config Store Option by name.

Request

DELETE /api/v1/platform/configuration/store/{config_option_id}

Path parameters

Name Type Required Description

config_option_id

string

Y

Name of the Config Store Option that you would like to delete

Responses

200

(EmptyResponse) Config Store Option deleted successfully

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
404
(BasicFailedReply) Config Store Option do not exist by that name. (code: platform.config.store.not_found)
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XDELETE {{hostname}}/api/v1/platform/configuration/store/{config_option_id} \
-u $CLOUD_USER:$CLOUD_KEY

Find Config Store Option by name

Find Config Store Option by name.

Request

GET /api/v1/platform/configuration/store/{config_option_id}

Path parameters

Name Type Required Description

config_option_id

string

Y

Name of the Config Store Option that you would like to find

Responses

200

(ConfigStoreOption) Config Store Option retrieved successfully

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
404
(BasicFailedReply) Config Store Option do not exist by that name. (code: platform.config.store.not_found)
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/configuration/store/{config_option_id} \
-u $CLOUD_USER:$CLOUD_KEY

Create Config Store Option

Inserts new Config Store Option.

Request

POST /api/v1/platform/configuration/store/{config_option_id}

Path parameters

Name Type Required Description

config_option_id

string

Y

Name of the Config Store Option that you would like to create

Request body

(ConfigStoreOptionData) (required) The Config Store Option definition

Responses

201

(ConfigStoreOption) The Config Store Option was inserted successfully

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
400
(BasicFailedReply) Config Store Option data already exists for the given name. (code: platform.config.store.already_exists)
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/platform/configuration/store/{config_option_id} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "value" : "string"
}
'

Update Config Store Option

Update existing Config Store Option.

Request

PUT /api/v1/platform/configuration/store/{config_option_id}

Path parameters

Name Type Required Description

config_option_id

string

Y

Name of the Config Store Option that you would like to modify

Query parameters

Name Type Required Description

version

integer

N

If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Request body

(ConfigStoreOptionData) (required) The Config Store Option definition

Responses

200

(ConfigStoreOption) Config Store Option retrieved successfully

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
404
(BasicFailedReply) There was no existing data for the given Config Store Id. (code: platform.config.store.not_found)
409
(BasicFailedReply) There is a version conflict. (code: platform.config.store.version_conflict)
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/platform/configuration/store/{config_option_id} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "value" : "string"
}
'
«  Platform - Runners     Platform - proxies  »