Make a GraphQL API request.
type: "io.kestra.plugin.graphql.request"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"
GraphQL query or mutation to execute.
The fully-qualified URI that points to the HTTP destination
If true, allow a failed response code (response code >= 400)
Deprecated, use options.allowFailed instead.
The full body as a string
application/jsonThe request content type
falseIf true, the GraphQL response body will be automatically encrypted and decrypted in the outputs.
If this property is set to true, this task will output the request body using the encryptedBody output property; otherwise, the request body will be stored in the body output property.
falseFail task on GraphQL errors
If true, the task will fail when GraphQL returns errors in the response.
The form data to be send
The headers to pass to the request
POSTThe HTTP method to use
Operation name for the GraphQL query
Used when multiple operations are defined in the query document.
{
"followRedirects": "true",
"allowFailed": "false",
"defaultCharset": "UTF-8"
}The HTTP request options
The SSL request options.
This property is deprecated. Instead use the options.ssl property.
Variables used in the query.
GraphQL variables can be complex objects with nested structures.
The GraphQL data field from the response.
Contains the data returned by the GraphQL server. If the encryptBody property is set to true, this will be null and the data will be in encryptedBody.
The status code of the response.
The encrypted body of the response.
If the encryptBody property is set to true, this will contain the encrypted response.
The GraphQL errors from the response.
Contains any errors returned by the GraphQL server.
The headers of the response.
uriThe URL of the current request.
durationThe time allowed to establish a connection to the server before failing.
PT5MdurationThe time allowed for a read connection to remain idle before closing it.
The password for HTTP basic authentication.
The username for HTTP basic authentication.
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentification to use.
The password for HTTP basic authentication.
The username for HTTP basic authentication.
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.
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.
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
The timeout configuration.
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.
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 token for bearer token authentication.