Enables clients to issue HTTP requests to a Splunk server.
| package | Splunk |
|---|
__construct(array $args)
array{
username: (optional) The username to login with. Defaults to
"admin".
password: (optional) The password to login with. Defaults to
"changeme".
token: (optional) The authentication token to use. If provided,
the username and password are ignored and there is no
need to call login(). In the format "Splunk SESSION_KEY".
host: (optional) The hostname of the Splunk server. Defaults to
"localhost".
port: (optional) The port of the Splunk server. Defaults to
8089.
scheme: (optional) The scheme to use: either "http" or "https".
Defaults to "https".
namespace: (optional) Namespace that all object lookups will
occur in by default. Defaults to
Splunk_Namespace::createDefault().
http: (optional) An Http object that will be used for
performing HTTP requests. This is intended for testing
only.
}
getHost() : string
stringThe hostname of the Splunk server.getNamespace() : \Splunk_Namespace
\Splunk_NamespaceThe default namespace that will be used
to perform collection and entity operations
when none is explicitly specified.getPort() : string
stringThe port of the Splunk server.getScheme() : string
stringThe scheme to use: either "http" or "https".getToken() : string
stringThe token used to authenticate HTTP requests
after logging in.login()
sendDelete(string $path, array $args) : \Splunk_HttpResponse
| see | \Splunk_Http::delete() |
|---|
stringrelative or absolute URL path.
array(optional) query parameters, merged with {
namespace: (optional) namespace to use, or NULL to use
this context's default namespace.
}
\Splunk_IOException |
|---|
\Splunk_HttpResponsesendGet(string $path, array $args) : \Splunk_HttpResponse
| see | \Splunk_Http::get() |
|---|
stringrelative or absolute URL path.
array(optional) query parameters, merged with {
namespace: (optional) namespace to use, or NULL to use
this context's default namespace.
}
\Splunk_IOException |
|---|
\Splunk_HttpResponsesendPost(string $path, array $args) : \Splunk_HttpResponse
| see | \Splunk_Http::post() |
|---|
stringrelative or absolute URL path.
array(optional) form parameters to send in the
request body, merged with {
namespace: (optional) namespace to use, or NULL to use
this context's default namespace.
}
\Splunk_IOException |
|---|
\Splunk_HttpResponsesendRequest(string $method, string $path, array $requestHeaders, string $requestBody, array $args) : \Splunk_HttpResponse
| see | \Splunk_Http::request() |
|---|
stringthe HTTP method (ex: 'GET' or 'POST').
stringrelative or absolute URL path.
array(optional) dictionary of header names and values.
string(optional) content to send in the request.
array(optional) query parameters, merged with
{
namespace: (optional) namespace to use, or NULL to use
this context's default namespace.
}
\Splunk_IOException |
|---|
\Splunk_HttpResponseabspath(string $path, \Splunk_Namespace | NULL $namespace) : string
stringRelative or absolute URL path.
stringAbsolute URL path.getRequestHeaders()
sendSimpleRequest($method, $path, $args)
url(string $path, \Splunk_Namespace | NULL $namespace) : string
stringRelative or absolute URL path.
stringAbsolute URL.$host
$http
$namespace
$password
$port
$scheme
$token
$username