YANPM/public/agent-client/docs/NginxAgentApi.md

\NginxAgentApi

All URIs are relative to http://localhost

Method	HTTP request	Description
status	GET /status	Health check endpoint
validate	POST /validate
validate_and_reload	POST /validate_and_reload
write_config	POST /write_config

status

models::StatusResp status() Health check endpoint

Parameters

This endpoint does not need any parameter.

Return type

models::StatusResp

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate

serde_json::Value validate(validate_body)

Parameters

Name	Type	Description	Required	Notes
validate_body	ValidateBody		[required]

Return type

serde_json::Value

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validate_and_reload

models::ValidateAndReloadResp validate_and_reload(validate_and_reload_body)

Parameters

Name	Type	Description	Required	Notes
validate_and_reload_body	ValidateAndReloadBody		[required]

Return type

models::ValidateAndReloadResp

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

write_config

write_config(write_config_body)

Parameters

Name	Type	Description	Required	Notes
write_config_body	WriteConfigBody		[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]