gdeploy REST API currently supports only JSON format. This is a beta version. There is no Authentication or Authorization mechanisms integrated.

gdeploy being a framework that accepts the configuration for whatever infrastructure one means to deploy in a configuration file now has a REST API that can accept these configuration in JSON format.

In this release of the API, the user can feed whichever configuration she wants in a JSON format and get it running. These configuration can be updated and re-run as per user requirements.

To have the API endpoint running, execute:

python gdeployapi.py <port> <host ip>

To add setup configurations:

• Method: POST
• Endpoint: /gdeploy/config/{id}
• Content-Type: application/json
• Response HTTP Status Code: 201 Created
• Response HTTP Error Code: 304 Not Modified if record with {id} key already present
• Response HTTP Error Code: 422 Unprocessable Entity if the Content type is not 'application/json'
• Response HTTP Error Code: 400 Bad Request if the URI is wrong
• JSON Request: The configuration sections and options expected for any setup as per the configuration file are expected here as well. The only difference is this should be provided in JSON format. Example:

{
  'hosts': '10.70.46.13',
  'backend-setup': {
        'devices': 'vd{a,b}'
        }
}

To list already fed setup configurations:

• Method: GET
• Endpoint: /gdeploy/config/{id}
• Content-Type: application/json
• Response HTTP Status Code: 200 OK
• Response HTTP Error Code: 404 Not Found if record with {id} key is not found
• Response HTTP Error Code: 400 Bad Request if the URI is wrong
• JSON Request: Empty
• JSON Response: Will list the section

To run deployment using one particular configuration

• Method: POST
• Endpoint: /gdeploy/deployconfig/{id}
• Content-Type: application/json
• Response HTTP Status Code: 200 OK
• Response HTTP Error Code: 404 Not Found if record with {id} key is not found
• Response HTTP Error Code: 400 Bad Request if the URI is wrong
• JSON Request: Empty

To update one particular configuration

• Method: PUT
• Endpoint: /gdeploy/config/{id}
• Content-Type: application/json
• Response HTTP Status Code: 201 Created
• Response HTTP Error Code: 404 Not Found if record with {id} key is not found
• Response HTTP Error Code: 422 Unprocessable Entity if the Content type is not 'application/json'
• Response HTTP Error Code: 400 Bad Request if the URI is wrong
• JSON Request: The updated configuration in JSON format Example:

{
  'hosts': '10.70.46.13',
  'backend-reset': {
        'pvs': 'vd{a,b}',
        'unmount': 'true'
        }
}

To delete one particular configuration

• Method: DELETE
• Endpoint: /gdeploy/config/{id}
• Content-Type: application/json
• Response HTTP Status Code: 200 OK
• Response HTTP Error Code: 404 Not Found if record with {id} key is not found
• Response HTTP Error Code: 400 Bad Request if the URI is wrong
• JSON Request: Empty