HTTP - script API

StackState Self-hosted v5.1.x

Sometimes it may be useful to process the retrieved topology or telemetry data using an external tool. For example, to perform analysis using a custom Python script, a cloud service or a Machine Learning framework. StackState can call out to any external service via HTTP using the functions in this script API.

To execute scripts using the HTTP script API in the StackState UI analytics environment, a user must have the permission execute-restricted-scripts. For details, see the analytics page permissions.

Function: HTTP.get(uri: String)

Submit HTTP get request.

Args

• uri - uri of the HTTP server.

Builder methods

• .timeout(time: Duration) - make the request timeout after time has elapsed.

• .param(name: String, value: String) - specify the query.

• .header(name: String, value: String) - specify the header.

• .noProxy() - even when a proxy is configured don't use it for this request.

Return type

• Async: HttpScriptApiTextResponse or HttpScriptApiJsonResponse if .jsonResponse() is used.

Examples

Http.get("https://www.google.com/?q=apples")
    .timeout("30s")
    .param("name", "value")
    .header("name", "value")

Function: HTTP.put(uri: String)

Submit HTTP put request.

Args

• uri - uri of the HTTP server.

Builder methods

• .timeout(time: Duration) - make the request timeout after time has elapsed.

• .param(name: String, value: String) - specify the query.

• .header(name: String, value: String) - specify the header.

• .noProxy() - even when a proxy is configured don't use it for this request.

• .contentType(contentType: String) - specify the content type, for example "application/text".

• .textRequest(text: String) - specify the text of the request.

• .jsonRequest(json: Goovy.lang.Closures) - specify the JSON of the request. This will wrap the given closure with a JsonBuilder.

• .jsonBody() - get the body of the JSON response.

• .jsonResponse() - get the JSON response.

Return type

• AsyncScriptResult[HttpScriptApiTextResponse] or AsyncScriptResult[HttpScriptApiJsonResponse] if .jsonResponse() is used.

Examples

Http.put("http://http_server:8080/api")
  .timeout("30s")
  .param("name", "value")
  .header("name", "value")
  .noProxy()
  .contentType("application/text")
  .textRequest("{'property', 'value'}")
  .jsonResponse()

Function: HTTP.post(uri: String)

Submit HTTP post request.

Args

• uri - uri of the HTTP server.

Builder methods

• .timeout(time: Duration) - make the request timeout after time has elapsed.

• .param(name: String, value: String) - specify the query.

• .header(name: String, value: String) - specify the header.

• .noProxy() - even when a proxy is configured don't use it for this request.

• .contentType(contentType: String) - specify the content type, for example "application/text".

• .textRequest(text: String) - specify the text of the request.

• .jsonRequest(json: Goovy.lang.Closures) - specify the JSON of the request. This will wrap the given closure with a JsonBuilder.

• .jsonBody() - get the body of the JSON response.

• .jsonResponse() - get the JSON response.

Return type

• AsyncScriptResult[HttpScriptApiTextResponse] or AsyncScriptResult[HttpScriptApiJsonResponse] if .jsonResponse() is used.

Examples

Http.post("http://http_server:8080/api")
    .timeout("30s")
    .param("name", "value")
    .header("name", "value")
    .jsonRequest {
    basicProperty "value"
    objectProperty {
    basicProperty 42.0
    }
    listProperty (["list item"])
}.jsonBody()

Function: HTTP.delete(uri: String)

Submit HTTP delete request.

Args

• uri - uri of the HTTP server.

Builder methods

• .timeout(time: Duration) - make the request timeout after time has elapsed.

• .param(name: String, value: String) - specify the query.

• .header(name: String, value: String) - specify the header.

• .noProxy() - even when a proxy is configured don't use it for this request.

Return type

• AsyncScriptResult[HttpScriptApiTextResponse] or AsyncScriptResult[HttpScriptApiJsonResponse] if .jsonResponse() is used.

Examples

Http.delete("http://http_server:8080/api")
    .timeout("30s")
    .param("name", "value")
    .header("name", "value")

Function: HTTP.options(uri: String)

Submit HTTP options request.

Args

• uri - uri of the HTTP server.

Examples

Http.options("http://http_server:8080/api")
    .timeout("30s")
    .param("name", "value")
    .header("name", "value")

Function: HTTP.patch(uri: String)

Submit HTTP patch request.

Args

• uri - uri of the HTTP server.

Builder methods

• .timeout(time: Duration) - make the request timeout after time has elapsed.

• .param(name: String, value: String) - specify the query.

• .header(name: String, value: String) - specify the header.

• .noProxy() - even when a proxy is configured don't use it for this request.

• .contentType(contentType: String) - specify the content type, for example "application/text".

• .textRequest(text: String) - specify the text of the request.

• .jsonRequest(json: Goovy.lang.Closures) - specify the JSON of the request. This will wrap the given closure with a JsonBuilder.

• .jsonBody() - get the body of the JSON response.

• .jsonResponse() - get the JSON response.

Return type

• AsyncScriptResult[HttpScriptApiTextResponse] or AsyncScriptResult[HttpScriptApiJsonResponse] if .jsonResponse() is used.

Examples

Http.patch("http://http_server:8080/api")
    .timeout("30s")
    .param("name", "value")
    .header("name", "value")
    .textRequest("{'property', 'value'}")

Function: HTTP.head(uri: String)

Submit HTTP head request.

Args

• uri - uri of the HTTP server.

Builder methods

• .timeout(time: Duration) - make the request timeout after time has elapsed.

• .param(name: String, value: String) - specify the query.

• .noProxy() - even when a proxy is configured don't use it for this request.

• .header(name: String, value: String) - specify the header.

Return type

• AsyncScriptResult[HttpScriptApiTextResponse] or AsyncScriptResult[HttpScriptApiJsonResponse] if .jsonResponse() is used.

Examples

Http.head("http://http_server:8080/api")
    .timeout("30s")
    .param("name", "value")
    .header("name", "value")