GraphQL Request
CertifiedExecute a GraphQL HTTP request
GraphQL Request
Execute a GraphQL HTTP request
Sends a rendered GraphQL query or mutation over HTTP (default POST). Supports optional variables and operationName, can encrypt the response body when encryptBody is true, and only fails on GraphQL errors if failOnGraphQLErrors is enabled.
type: io.kestra.plugin.graphql.RequestExamples
Make a GraphQL query with variables
id: graphql_request
namespace: company.team
tasks:
- id: graphql_query
type: io.kestra.plugin.graphql.Request
uri: https://example.com/graphql
query: |
query GetUser($userId: ID!) {
user(id: $userId) {
name
email
}
}
variables:
userId: "12345"
Execute a GraphQL query with authentication
id: graphql_with_auth
namespace: company.team
tasks:
- id: get_data
type: io.kestra.plugin.graphql.Request
uri: https://example.com/graphql
headers:
Authorization: "Bearer {{ secret('API_TOKEN') }}"
query: |
query {
viewer {
name
email
}
}
Execute a GraphQL query with operationName
id: graphql_with_operation_name
namespace: company.team
tasks:
- id: get_data
type: io.kestra.plugin.graphql.Request
uri: https://example.com/graphql
query: |
query GetUser {
user(id: "1") {
name
}
}
query GetPosts {
posts {
title
}
}
operationName: "GetUser"
Properties
query *Requiredstring
GraphQL query or mutation
Rendered from the flow context before the request.
uri *Requiredstring
The fully-qualified URI that points to the HTTP destination
body string
The full body as a string
contentType string
application/jsonThe request content type
encryptBody booleanstring
falseEncrypt response body
When true, stores GraphQL data in the encryptedBody output instead of body; default is false.
failOnGraphQLErrors booleanstring
falseFail task on GraphQL errors
If true, the task fails when the response contains GraphQL errors; defaults to false.
formData object
The form data to be send
headers object
The headers to pass to the request
method string
POSTThe HTTP method to use
operationName string
Operation name to run
Required when the query document defines multiple operations.
options Non-dynamic
{
"followRedirects": "true",
"allowFailed": "false",
"enabledTcpExtendedKeepAlive": "true",
"defaultCharset": "UTF-8"
}The HTTP request options
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
params object
The query string parameter to use
Adds parameter to URI query. The parameter name and value are expected to be unescaped and may contain non ASCII characters.
The value can be a string or a list of strings.
This method will not override parameters already existing on uri and will add them as array.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
variables object
Variables for the query
Rendered GraphQL variables; supports nested objects.
Outputs
body object
GraphQL data from the response
Contains the data field returned by the GraphQL server. Null when encryptBody is true; data is then available in encryptedBody.
code integer
HTTP status code of the response
encryptedBody string
Encrypted response body
Contains the encrypted response when encryptBody is true.
error object
GraphQL errors from the response
Any errors returned by the GraphQL server.
headers object
Response headers
uri string
uriThe URL of the current request
