Promenade API Documentation


Allows other components to validate Promenade’s health status.

GET /v1.0/health

Returns the health status.


  • 204 No Content


Generates join scripts and for Drydock.

GET /v1.0/join-scripts

Generates script to be consumed by Drydock.

Query parameters

Name of the node
IP address of the node
Endpoint containing configuration documents
Used to set configuration options in the generated script
Used to set configuration options in the generated script


  • 200 OK: Script returned as response body
  • 400 Bad Request: One or more query parameters is missing or misspelled


Performs validations against specified documents.

POST /v1.0/validatedesign

Performs validation against specified documents.

Message Body

Location of the document to be validated


  • 200 OK: Documents were successfully validated
  • 400 Bad Request: Documents were not successfully validated


Update node labels

PUT /v1.0/node-labels/<node_name>

Updates node labels eg: adding new labels, overriding existing labels and deleting labels from a node.

Message Body:

dict of labels

{"label-a": "value1", "label-b": "value2", "label-c": "value3"}


  • 200 OK: Labels successfully updated
  • 400 Bad Request: Bad input format
  • 401 Unauthorized: Unauthenticated access
  • 403 Forbidden: Unauthorized access
  • 404 Not Found: Bad URL or Node not found
  • 500 Internal Server Error: Server error encountered
  • 502 Bad Gateway: Kubernetes Config Error
  • 503 Service Unavailable: Failed to interact with Kubernetes API