# Load Balancer SDK ## POST /v3/highlvl/create\_load\_balancer\_orchestration > Create Load Balancer Orchestration ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Load Balancer Lifecycle (v3)","description":"Orchestration and core management of Load Balancer resources."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v3/highlvl/create_load_balancer_orchestration":{"post":{"tags":["Load Balancer Lifecycle (v3)"],"summary":"Create Load Balancer Orchestration","parameters":[{"$ref":"#/components/parameters/XRegion"},{"$ref":"#/components/parameters/KCustomerId"},{"$ref":"#/components/parameters/XAccountId"},{"$ref":"#/components/parameters/Authorization"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LBOrchestrationRequest"}}}},"responses":{"202":{"description":"Orchestration task accepted."}}}}},"components":{"parameters":{"XRegion":{"name":"x-region","in":"header","required":true,"schema":{"type":"string"}},"KCustomerId":{"name":"k-customer-id","in":"header","required":true,"schema":{"type":"string"}},"XAccountId":{"name":"x-account-id","in":"header","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}},"schemas":{"LBOrchestrationRequest":{"type":"object","properties":{"loadbalancer_data":{"type":"object"},"listeners":{"type":"array","items":{"type":"object"}}}}}}} ``` ## POST /v3/highlvl/update\_load\_balancer/{lb\_krn} > Update Load Balancer ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Load Balancer Lifecycle (v3)","description":"Orchestration and core management of Load Balancer resources."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v3/highlvl/update_load_balancer/{lb_krn}":{"post":{"tags":["Load Balancer Lifecycle (v3)"],"summary":"Update Load Balancer","parameters":[{"name":"lb_krn","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XRegion"},{"$ref":"#/components/parameters/Authorization"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLoadBalancerRequest"}}}},"responses":{"200":{"description":"Load balancer updated successfully."}}}}},"components":{"parameters":{"XRegion":{"name":"x-region","in":"header","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}},"schemas":{"UpdateLoadBalancerRequest":{"type":"object","properties":{"lb_krn":{"type":"string"},"loadbalancer_data":{"type":"object"},"listeners":{"type":"array","items":{"type":"object"}}}}}}} ``` ## DELETE /v3/highlvl/loadbalancer/{lb\_krn} > Delete Load Balancer ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Load Balancer Lifecycle (v3)","description":"Orchestration and core management of Load Balancer resources."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v3/highlvl/loadbalancer/{lb_krn}":{"delete":{"tags":["Load Balancer Lifecycle (v3)"],"summary":"Delete Load Balancer","parameters":[{"name":"lb_krn","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XRegion"},{"$ref":"#/components/parameters/Authorization"}],"responses":{"204":{"description":"Deletion initiated."}}}}},"components":{"parameters":{"XRegion":{"name":"x-region","in":"header","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}}}} ``` ## GET /v3/highlvl/fetch\_payload\_multiple/{lb\_krn} > Fetch Detailed LB Payload ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Discovery & Monitoring","description":"Status tracking and resource listing endpoints."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v3/highlvl/fetch_payload_multiple/{lb_krn}":{"get":{"tags":["Discovery & Monitoring"],"summary":"Fetch Detailed LB Payload","parameters":[{"name":"lb_krn","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Authorization"}],"responses":{"200":{"description":"Full configuration payload returned."}}}}},"components":{"parameters":{"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}}}} ``` ## GET /v3/highlvl/get\_lb\_list\_new/{vpc\_krn} > List Load Balancers by VPC ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Discovery & Monitoring","description":"Status tracking and resource listing endpoints."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v3/highlvl/get_lb_list_new/{vpc_krn}":{"get":{"tags":["Discovery & Monitoring"],"summary":"List Load Balancers by VPC","parameters":[{"name":"vpc_krn","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Authorization"}],"responses":{"200":{"description":"List of load balancers."}}}}},"components":{"parameters":{"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}}}} ``` ## GET /v3/highlvl/task\_status/{task\_id} > Get Task Status ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Discovery & Monitoring","description":"Status tracking and resource listing endpoints."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v3/highlvl/task_status/{task_id}":{"get":{"tags":["Discovery & Monitoring"],"summary":"Get Task Status","parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/Authorization"}],"responses":{"200":{"description":"Current task progress."}}}}},"components":{"parameters":{"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}}}} ``` ## POST /v1/highlvl/create\_target\_group > Create Target Group ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Target Group Management (v1)","description":"Creation, updates, and deletion of backend Target Groups."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v1/highlvl/create_target_group":{"post":{"tags":["Target Group Management (v1)"],"summary":"Create Target Group","parameters":[{"$ref":"#/components/parameters/XRegion"},{"$ref":"#/components/parameters/Authorization"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetGroupRequest"}}}},"responses":{"201":{"description":"Target group created."}}}}},"components":{"parameters":{"XRegion":{"name":"x-region","in":"header","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}},"schemas":{"TargetGroupRequest":{"type":"object","properties":{"vpc_id":{"type":"string"},"target_group_name":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"protocol_port":{"type":"integer"},"weight":{"type":"integer"}}}},"health_monitor":{"type":"object","properties":{"h_type":{"type":"string"},"timeout":{"type":"integer"},"delay":{"type":"integer"},"url_path":{"type":"string"}}}}}}}} ``` ## POST /v1/highlvl/updatetg > Update Target Group Members/Health ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Target Group Management (v1)","description":"Creation, updates, and deletion of backend Target Groups."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v1/highlvl/updatetg":{"post":{"tags":["Target Group Management (v1)"],"summary":"Update Target Group Members/Health","parameters":[{"$ref":"#/components/parameters/XRegion"},{"$ref":"#/components/parameters/Authorization"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetGroupRequest"}}}},"responses":{"200":{"description":"Target group updated."}}}}},"components":{"parameters":{"XRegion":{"name":"x-region","in":"header","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}},"schemas":{"TargetGroupRequest":{"type":"object","properties":{"vpc_id":{"type":"string"},"target_group_name":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"protocol_port":{"type":"integer"},"weight":{"type":"integer"}}}},"health_monitor":{"type":"object","properties":{"h_type":{"type":"string"},"timeout":{"type":"integer"},"delay":{"type":"integer"},"url_path":{"type":"string"}}}}}}}} ``` ## DELETE /v1/highlvl/target\_group > Delete Target Group ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Target Group Management (v1)","description":"Creation, updates, and deletion of backend Target Groups."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v1/highlvl/target_group":{"delete":{"tags":["Target Group Management (v1)"],"summary":"Delete Target Group","parameters":[{"$ref":"#/components/parameters/VpcIdQuery"},{"name":"target_group_name","in":"query","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/Authorization"}],"responses":{"200":{"description":"Target group deleted."}}}}},"components":{"parameters":{"VpcIdQuery":{"name":"vpc_id","in":"query","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}}}} ``` ## GET /v1/highlvl/get\_tg\_list > Get Full TG List ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Discovery & Monitoring","description":"Status tracking and resource listing endpoints."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v1/highlvl/get_tg_list":{"get":{"tags":["Discovery & Monitoring"],"summary":"Get Full TG List","parameters":[{"$ref":"#/components/parameters/VpcIdQuery"},{"$ref":"#/components/parameters/Authorization"}],"responses":{"200":{"description":"Comprehensive list of target groups."}}}}},"components":{"parameters":{"VpcIdQuery":{"name":"vpc_id","in":"query","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}}}} ``` ## GET /v1/highlvl/get\_target\_groups > Get Detailed Target Groups ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Discovery & Monitoring","description":"Status tracking and resource listing endpoints."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v1/highlvl/get_target_groups":{"get":{"tags":["Discovery & Monitoring"],"summary":"Get Detailed Target Groups","parameters":[{"$ref":"#/components/parameters/VpcIdQuery"},{"name":"target_group_name","in":"query","schema":{"type":"string"}},{"$ref":"#/components/parameters/Authorization"}],"responses":{"200":{"description":"Detailed TG info."}}}}},"components":{"parameters":{"VpcIdQuery":{"name":"vpc_id","in":"query","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}}}} ``` ## GET /v1/highlvl/get\_target\_group\_names > Get TG Names Only ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"tags":[{"name":"Discovery & Monitoring","description":"Status tracking and resource listing endpoints."}],"servers":[{"url":"https://r1.staging.olakrutrim.com","description":"Staging Environment"}],"paths":{"/v1/highlvl/get_target_group_names":{"get":{"tags":["Discovery & Monitoring"],"summary":"Get TG Names Only","parameters":[{"$ref":"#/components/parameters/VpcIdQuery"},{"$ref":"#/components/parameters/Authorization"}],"responses":{"200":{"description":"Array of strings containing TG names."}}}}},"components":{"parameters":{"VpcIdQuery":{"name":"vpc_id","in":"query","required":true,"schema":{"type":"string"}},"Authorization":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}}}} ``` ## The LBOrchestrationRequest object ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"components":{"schemas":{"LBOrchestrationRequest":{"type":"object","properties":{"loadbalancer_data":{"type":"object"},"listeners":{"type":"array","items":{"type":"object"}}}}}}} ``` ## The UpdateLoadBalancerRequest object ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"components":{"schemas":{"UpdateLoadBalancerRequest":{"type":"object","properties":{"lb_krn":{"type":"string"},"loadbalancer_data":{"type":"object"},"listeners":{"type":"array","items":{"type":"object"}}}}}}} ``` ## The TargetGroupRequest object ```json {"openapi":"3.0.0","info":{"title":"Krutrim Load Balancer Orchestration API","version":"1.0.0"},"components":{"schemas":{"TargetGroupRequest":{"type":"object","properties":{"vpc_id":{"type":"string"},"target_group_name":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"protocol_port":{"type":"integer"},"weight":{"type":"integer"}}}},"health_monitor":{"type":"object","properties":{"h_type":{"type":"string"},"timeout":{"type":"integer"},"delay":{"type":"integer"},"url_path":{"type":"string"}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.cloud.olakrutrim.com/sdk-guide/load-balancer-sdk.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.