API reference for Distributed Key Value store
API reference for Distributed Key Value store.
Version: 1.0.0
BasePath:/v1
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
get /config/load-default
Load default config into Consul. (configLoadDefaultGet)
Load default config into Consul upon hitting the endpoint.
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
ConfigDefaultGETResponse
Load config into Consul. (configLoadPost)
Load config into Consul upon hitting the endpoint.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Load configuration from file system to be added into Consul
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
ConfigLoadPOSTResponse
Endpoint to upload configuration. (configPost)
Endpoint to upload configuration.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
configFile (required)
Form Parameter — Config file to be uploaded.
token (required)
Form Parameter — Token to identify domain to upload config file to.
subdomain (optional)
Form Parameter — Subdomain to identify subdomain to upload config file to.
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
ConfigUploadResponse
Up
delete /config/{token}/{filename}
Delete config file. (configTokenFilenameDelete)
Deletes a config file identified by token and filename.
Path parameters
token (required)
Path Parameter — Token used to delete
filename (required)
Path Parameter — Filename used to delete
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
ConfigDomainDELETEResponse
Up
get /config/{token}/{filename}
Get config file. (configTokenFilenameGet)
Get config file identified by token and filename.
Path parameters
token (required)
Path Parameter — Token used to get config file.
filename (required)
Path Parameter — Filename used to get config file.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
Up
delete /config/{token}/{subdomain}/{filename}
Delete config file from subdomain. (configTokenSubdomainFilenameDelete)
Deletes a config file identified by token, filename and subdomain.
Path parameters
token (required)
Path Parameter — Token used to delete config file.
subdomain (required)
Path Parameter — Subdomain used to delete config file.
filename (required)
Path Parameter — Filename used to delete config file.
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
ConfigSubDomainDELETEResponse
Up
get /config/{token}/{subdomain}/{filename}
Get config file from subdomain. (configTokenSubdomainFilenameGet)
Get config file identified by token, filename and subdomain.
Path parameters
token (required)
Path Parameter — Token used to get config file.
subdomain (required)
Path Parameter — Subdomain used to get config file.
filename (required)
Path Parameter — Filename used to get config file.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
Up
delete /deleteconfig/{key}
Delete value for specific key present in Consul. (deleteconfigKeyDelete)
Deletes a specific key.
Path parameters
key (required)
Path Parameter — Key used to delete
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
ConsulDELETEResponse
Get value for specific key present in Consul. (getconfigKeyGet)
Returns a key and value present in Consul.
Path parameters
key (required)
Path Parameter — Key used to query Consul.
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
ConsulGETResponse
Get all keys present in Consul. (getconfigsGet)
Returns a list of keys present in Consul.
Return type
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
ConsulGETAllResponse
Endpoint to Register new domain (registerPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Register new domain.
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
RegisterDomainPOSTResponse
Up
delete /register/{token}
Delete registered domain. (registerTokenDelete)
Deletes a registered domain identified by token.
Path parameters
token (required)
Path Parameter — Token used to delete
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
RegisterDomainDELETEResponse
Check if domain is registered. (registerTokenGet)
Check if domain is registered identified by token.
Path parameters
token (required)
Path Parameter — Token used to query
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
RegisterDomainGETResponse
Up
post /register/{token}/subdomain
Endpoint to Register new subdomain (registerTokenSubdomainPost)
Path parameters
token (required)
Path Parameter — Token used to identify domain.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Register new subdomain.
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
RegisterSubdomainPOSTResponse
Up
delete /register/{token}/subdomain/{subdomain}
Delete registered subdomain. (registerTokenSubdomainSubdomainDelete)
Deletes a registered subdomain identified by token and subdomain.
Path parameters
token (required)
Path Parameter — Token used to delete
subdomain (required)
Path Parameter — Subdomain used to delete
Return type
Example data
Content-Type: application/json
{
"response" : "response"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
RegisterSubDomainDELETEResponse
[ Jump to Methods ]
Table of Contents
ConfigDefaultGETResponse - ConfigDomainDELETEResponse - ConfigLoadPOSTRequest - ConfigLoadPOSTResponse - ConfigSubDomainDELETEResponse - ConfigUploadResponse - ConsulDELETEResponse - ConsulGETAllResponse - ConsulGETResponse - RegisterDomainDELETEResponse - RegisterDomainGETResponse - RegisterDomainPOSTRequest - RegisterDomainPOSTResponse - RegisterSubDomainDELETEResponse - RegisterSubdomainPOSTRequest - RegisterSubdomainPOSTResponse -
token (optional)
filename (optional)
subdomain (optional)