Offered APIs

POST /register

Endpoint to Register new domain

  • Produces: [u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body Register new domain.

Responses

200 - successful operation

DELETE /config/{token}/{subdomain}/{filename}

Delete config file from subdomain.

  • Produces: [u’application/json’]
  • Description: Deletes a config file identified by token, filename and subdomain.

Parameters

Name Position Description Type
token path Token used to delete config file. string
subdomain path Subdomain used to delete config file. string
filename path Filename used to delete config file. string

Responses

200 - successful operation

GET /config/{token}/{subdomain}/{filename}

Get config file from subdomain.

  • Produces: [u’file’]
  • Description: Get config file identified by token, filename and subdomain.

Parameters

Name Position Description Type
token path Token used to get config file. string
subdomain path Subdomain used to get config file. string
filename path Filename used to get config file. string

Responses

200 - successful operation

DELETE /register/{token}/subdomain/{subdomain}

Delete registered subdomain.

  • Produces: [u’application/json’]
  • Description: Deletes a registered subdomain identified by token and subdomain.

Parameters

Name Position Description Type
token path Token used to delete string
subdomain path Subdomain used to delete string

Responses

200 - successful operation

GET /getconfig/{key}

Get value for specific key present in Consul.

  • Produces: [u’application/json’]
  • Description: Returns a key and value present in Consul.

Parameters

Name Position Description Type
key path Key used to query Consul. string

Responses

200 - successful operation

GET /getconfigs

Get all keys present in Consul.

  • Produces: [u’application/json’]
  • Description: Returns a list of keys present in Consul.

Responses

200 - successful operation

DELETE /deleteconfig/{key}

Delete value for specific key present in Consul.

  • Produces: [u’application/json’]
  • Description: Deletes a specific key.

Parameters

Name Position Description Type
key path Key used to delete string

Responses

200 - successful operation

DELETE /config/{token}/{filename}

Delete config file.

  • Produces: [u’application/json’]
  • Description: Deletes a config file identified by token and filename.

Parameters

Name Position Description Type
token path Token used to delete string
filename path Filename used to delete string

Responses

200 - successful operation

GET /config/{token}/{filename}

Get config file.

  • Produces: [u’file’]
  • Description: Get config file identified by token and filename.

Parameters

Name Position Description Type
token path Token used to get config file. string
filename path Filename used to get config file. string

Responses

200 - successful operation

POST /register/{token}/subdomain

Endpoint to Register new subdomain

  • Produces: [u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
token path Token used to identify domain. string
body body Register new subdomain.

Responses

200 - successful operation

GET /config/load-default

Load default config into Consul.

  • Produces: [u’application/json’]
  • Description: Load default config into Consul upon hitting the endpoint.

Responses

200 - successful operation

POST /config

Endpoint to upload configuration.

  • Produces: [u’application/json’]
  • Description: Endpoint to upload configuration.
  • Consumes: [u’multipart/form-data’]

Parameters

Name Position Description Type
configFile formData Config file to be uploaded. file
token formData Token to identify domain to upload config file to. string
subdomain formData Subdomain to identify subdomain to upload config file to. string

Responses

200 - successful operation

DELETE /register/{token}

Delete registered domain.

  • Produces: [u’application/json’]
  • Description: Deletes a registered domain identified by token.

Parameters

Name Position Description Type
token path Token used to delete string

Responses

200 - successful operation

GET /register/{token}

Check if domain is registered.

  • Produces: [u’application/json’]
  • Description: Check if domain is registered identified by token.

Parameters

Name Position Description Type
token path Token used to query string

Responses

200 - successful operation

POST /config/load

Load config into Consul.

  • Produces: [u’application/json’]
  • Description: Load config into Consul upon hitting the endpoint.
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body Load configuration from file system to be added into Consul

Responses

200 - successful operation